広告のエクスポート
curl --request POST \
--url https://api.pubrio.com/companies/advertisements/export \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"companies": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"domains": [
"pubrio.com"
],
"exclude_fields": [
"emails",
"phones",
"contacts"
],
"exclude_data_export_fields": [
"raw_html"
],
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/companies/advertisements/export"
payload = {
"companies": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"domains": ["pubrio.com"],
"exclude_fields": ["emails", "phones", "contacts"],
"exclude_data_export_fields": ["raw_html"],
"profile_id": 123
}
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
domains: ['pubrio.com'],
exclude_fields: ['emails', 'phones', 'contacts'],
exclude_data_export_fields: ['raw_html'],
profile_id: 123
})
};
fetch('https://api.pubrio.com/companies/advertisements/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pubrio.com/companies/advertisements/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companies' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'domains' => [
'pubrio.com'
],
'exclude_fields' => [
'emails',
'phones',
'contacts'
],
'exclude_data_export_fields' => [
'raw_html'
],
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pubrio.com/companies/advertisements/export"
payload := strings.NewReader("{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pubrio.com/companies/advertisements/export")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/companies/advertisements/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": [
{}
]
}エクスポート
企業広告のエクスポート
指定した企業の広告レコードを、ダウンロード可能なデータセットとしてエクスポートします。data_export_credit を消費します。
POST
/
companies
/
advertisements
/
export
広告のエクスポート
curl --request POST \
--url https://api.pubrio.com/companies/advertisements/export \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"companies": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"domains": [
"pubrio.com"
],
"exclude_fields": [
"emails",
"phones",
"contacts"
],
"exclude_data_export_fields": [
"raw_html"
],
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/companies/advertisements/export"
payload = {
"companies": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"domains": ["pubrio.com"],
"exclude_fields": ["emails", "phones", "contacts"],
"exclude_data_export_fields": ["raw_html"],
"profile_id": 123
}
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
domains: ['pubrio.com'],
exclude_fields: ['emails', 'phones', 'contacts'],
exclude_data_export_fields: ['raw_html'],
profile_id: 123
})
};
fetch('https://api.pubrio.com/companies/advertisements/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pubrio.com/companies/advertisements/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companies' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'domains' => [
'pubrio.com'
],
'exclude_fields' => [
'emails',
'phones',
'contacts'
],
'exclude_data_export_fields' => [
'raw_html'
],
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pubrio.com/companies/advertisements/export"
payload := strings.NewReader("{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pubrio.com/companies/advertisements/export")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/companies/advertisements/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"domains\": [\n \"pubrio.com\"\n ],\n \"exclude_fields\": [\n \"emails\",\n \"phones\",\n \"contacts\"\n ],\n \"exclude_data_export_fields\": [\n \"raw_html\"\n ],\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": [
{}
]
}承認
ボディ
application/json
企業および人物検索処理で利用する domain_search_id の一覧です。
企業および人物検索に使用する会社ドメインの一覧です。www や URL スキームが含まれる場合も、自動的にルートドメインへ正規化されます。
例:
["pubrio.com"]レスポンスペイロードから除外するフィールドのリストです。
例:
["emails", "phones", "contacts"]生成されるエクスポートファイルから除外する列です(各レコードからフィールドを取り除く exclude_fields とは別のものです)。
例:
["raw_html"]オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。
レスポンス
200 - application/json
エクスポートされたレコードです。data_export_credit の残高から差し引かれます。
エクスポートされたレコードです。exclude_fields で指定したフィールドは除外されています。
⌘I

