Skip to main content
POST
企業広告検索

承認

pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
target_locations
string[]

国コードで特定の場所をターゲットにしている広告をフィルタリングします。特定の国で表示されている広告を検索します。filter_conditions と OR 演算子で組み合わせて使用します - 広告は指定された場所のうち少なくとも 1 つをターゲットにしている必要があります。

:
exclude_target_locations
string[]

国コードで特定の場所をターゲットにしている広告を除外します。特定の国で表示されている広告をフィルタリング除外します。filter_conditions で演算子 'or' とともに指定された場合、広告は除外された場所のどれもターゲットにしていない必要があります。

:
search_terms
string[]

検索結果を絞り込むために使用するキーワード文字列のリストです。

:
headlines
string[]

検索結果をフィルタリングするためのヘッドラインのリストです。

:
filter_conditions
object[]

広告検索の高度なフィルタリングオプションです。広告検索エンドポイントの検索結果を調整するための条件を指定します。

start_dates
string<date>[]

検索結果をフィルタリングするための開始日付のリストです。

:
end_dates
string<date>[]

検索結果をフィルタリングするための終了日付のリストです。

:
company_locations
string[]

企業本社の所在地を示すフィルターです。

:
companies
string<uuid>[]

企業および人物検索処理で利用する domain_search_id の一覧です。

domains
string[]

企業および人物検索に使用する会社ドメインの一覧です。www や URL スキームが含まれる場合も、自動的にルートドメインへ正規化されます。

:
linkedin_urls
string[]

企業の LinkedIn 公式ページを指す完全な URL です。値は http で始まり、linkedin.com/company/ を含んでいる必要があります。

:
is_realtime_enrichment
boolean
デフォルト:false

単一企業スコープのクエリ(domain_search_iddomains、または linkedin_urls でフィルタリング)でリアルタイムエンリッチメントを有効化します。初回検索が 0 件の場合、エンドポイントはソースをスクレイプし、レコードを保存したうえで検索を再実行してから応答します。ルートごとのデッドラインの対象です。

:

true

source_types
enum<string>[]

リアルタイムエンリッチメントの対象とする広告ソースタイプを制限します。省略した場合はすべてのソースが対象です。リアルタイムエンリッチメントが実際に実行される場合にのみ適用されます。すなわち、is_realtime_enrichment または enrichment_mode: latest が設定されている場合です。

利用可能なオプション:
linkedin,
facebook,
google
:
enrichment_mode
enum<string>
デフォルト:default

リアルタイムエンリッチメントの動作を制御します。default はデータベースにすでに存在するデータを返し、結果が空で is_realtime_enrichment が設定されている場合にのみエンリッチメントを実行します。latest はキャッシュをバイパスし、呼び出しごとに最新のソースレコードに対する再エンリッチメントを強制します。他のフラグが設定されていなくても、latest 自体が単独でエンリッチメントを起動します。

利用可能なオプション:
default,
latest
:

"latest"

per_page
integer

1 ページあたりに返される検索結果件数です。ページサイズを制限することで、レスポンス速度や API パフォーマンスの向上が期待できます。

:

25

page
integer

取得したい結果セットのページ番号です。

:

1

profile_id
integer

オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

publisher_platforms
enum<string>[]

配信された配置面で Facebook/Meta 広告をフィルタリングします。小文字で、大文字・小文字を区別しません。facebook ソースにのみ適用されます(他のソースは単一プラットフォーム)。

利用可能なオプション:
facebook,
instagram,
messenger,
threads,
audience_network
:
exclude_publisher_platforms
enum<string>[]

これらの配置面で配信された Facebook/Meta 広告を除外します。

利用可能なオプション:
facebook,
instagram,
messenger,
threads,
audience_network
:
is_include_unlinked_companies
boolean
デフォルト:false

解決済みの企業に紐づいていない広告(未加工レイヤーの広告。詐欺・使い捨てページ広告など)を含めます。デフォルトは false で、企業に紐づく広告のみを返します。

:

true

レスポンス

企業の広告検索詳細情報を含む成功レスポンスです。

data
object | null

エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。