有効なイベント マッチャーと、オーディエンス リストのフリークエンシー キャップのメタデータを一覧表示します。各イベント マッチャーには、所有する AdsDataLink.Entity や、対応するキャンペーンや広告申込情報の名前などのメタデータが含まれます。
HTTP リクエスト
GET https://adsdatahub.googleapis.com/v1/{customer=customers/*}:describeValidFrequencyLimitingEventMatchers
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
customer |
顧客のリソース名。例: 'customers/123'。 |
クエリ パラメータ
パラメータ | |
---|---|
adsDataCustomerId |
広告データを所有しているお客様 ID(例: 456)。 |
pageSize |
返される最大アイテム数。0 の場合、サーバーはリンク中の顧客の数を返します。 |
pageToken |
前の呼び出しによって返されたページトークン。次のページの結果を返すために使用されます。 |
filter |
返されるイベント マッチャーを制限します。eventMatcher、eventMatcherMetadata.entity、eventMatcherMetadata.parent_event_matcher のすべてのサブフィールドに対するフィルタを受け入れます。: |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
describeValidFrequencyLimitingEventMatchersRequest リクエストに対するレスポンス。
JSON 表現 |
---|
{
"eventMatcherInfos": [
{
object ( |
フィールド | |
---|---|
eventMatcherInfos[] |
ユニットのリスト(それぞれイベント マッチャーとメタデータを含む) |
nextPageToken |
次の結果ページのリクエストに使用できるトークン。他に結果がない場合、このフィールドは空です。 |
認証スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adsdatahub
イベント マッチャー情報
イベント マッチャーとそのメタデータ。
JSON 表現 |
---|
{ "eventMatcher": { object ( |
フィールド | |
---|---|
eventMatcher |
制約タイプと有効な制約 ID を含むイベント マッチャー。 |
eventMatcherMetadata |
イベント マッチャーのメタデータ。 |
EventMatcherMetadata
イベント マッチャーのメタデータ。
JSON 表現 |
---|
{ "entity": { object ( |
フィールド | |
---|---|
entity |
AdsDataLink のリンクされたエンティティ。 |
displayName |
制約の基盤となるデータストア内の名前。キャンペーン名、広告申込情報名などです。 |
parentEventMatcher |
関連する親 EventMatcher(存在する場合)。eventMatcher がディスプレイ&ビデオ 360 広告申込情報の場合、このフィールドは、広告申込情報が属しているディスプレイ&ビデオ 360 の対応する広告掲載オーダーの EventMatcher を参照します。 |