Method: firstPartyAndPartnerAudiences.list

ファーストパーティ オーディエンスとパートナー オーディエンスのリストを取得します。

順序は orderBy パラメータで定義されます。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。リクエストされたページサイズ。1～5000 の値を指定してください。指定しない場合、この値はデフォルトの 5000 になります。無効な値が指定された場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークン。通常、これは firstPartyAndPartnerAudiences.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
orderBy

string

省略可。リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • FirstPartyAndPartnerAudienceId（デフォルト）
  • displayName

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名の末尾に接尾辞「desc」を追加します。例: displayName desc。
filter

string

省略可。ファーストパーティ オーディエンス フィールドとパートナー オーディエンス フィールドでフィルタリングできます。

サポートされている構文:

  • ファーストパーティ オーディエンスとパートナー オーディエンスのフィルタ式には、制限を 1 つまでしか含めることができません。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで HAS (:) 演算子を使用する必要があります。

サポートされているフィールド:

  • displayName

例:

  • 表示名に「Google」を含むすべてのファーストパーティ オーディエンスとパートナー オーディエンス: displayName:"Google"。

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。
必須。リクエストが作成されているディスプレイ＆ビデオ 360 エンティティを識別します。LIST リクエストは、accessor 内で識別されたディスプレイ＆ビデオ 360 エンティティがアクセスできるファーストパーティ オーディエンス エンティティとパートナー オーディエンス エンティティのみを返します。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
partnerId

string (int64 format)

取得したファーストパーティ オーディエンスとパートナー オーディエンスにアクセスできるパートナーの ID。
advertiserId

string (int64 format)

取得したファーストパーティ オーディエンスとパートナー オーディエンスにアクセスできる広告主の ID。
相互に排他的なフィールドの終わり。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "firstPartyAndPartnerAudiences": [
    {
      object (FirstPartyAndPartnerAudience)
    }
  ],
  "nextPageToken": string
}
フィールド
firstPartyAndPartnerAudiences[]

object (FirstPartyAndPartnerAudience)

ファーストパーティ オーディエンスとパートナー オーディエンスのリスト。ユーザーの規模のプロパティは含まれません。

このリストが空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 この値を次の firstPartyAndPartnerAudiences.list メソッド呼び出しの pageToken フィールドで渡して、結果の次ページを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/display-video

詳細については、OAuth 2.0 Overview をご覧ください。