Method: combinedAudiences.list

統合オーディエンスの一覧を表示します。

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/combinedAudiences

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

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1～200 の範囲で指定してください。指定しない場合のデフォルトは 100 です。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

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

string

リストの並べ替え基準として使用するフィールド。有効な値は次のとおりです。

  • combinedAudienceId（デフォルト）
  • displayName

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

string

組み合わせオーディエンスのフィールドでフィルタできます。

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

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

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

  • displayName

例:

  • 表示名に「Google」が含まれるすべての統合オーディエンス: displayName : "Google"。

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

詳しくは、LIST リクエストのフィルタ ガイドをご覧ください。
結合パラメータ accessor。必須。リクエストが実行されているディスプレイ＆ビデオ 360 エンティティを識別します。LIST リクエストでは、accessor 内で識別されたディスプレイ＆ビデオ 360 エンティティにアクセスできる統合オーディエンス エンティティのみが返されます。accessor は次のいずれかになります。
partnerId

string (int64 format)

フェッチされた組み合わせオーディエンスにアクセスできるパートナーの ID。
advertiserId

string (int64 format)

フェッチされた組み合わせオーディエンスにアクセスできる広告主の ID。

リクエスト本文

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

レスポンスの本文

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

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

object (CombinedAudience)

組み合わせオーディエンスのリスト。

リストが空の場合は、このリストは表示されません。
nextPageToken

string

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。