Method: firstAndThirdPartyAudiences.list

ファースト パーティ オーディエンスとサードパーティ オーディエンスを一覧表示します。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • firstAndThirdPartyAudienceId（デフォルト）
  • 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 表現 
{
  "firstAndThirdPartyAudiences": [
    {
      object (FirstAndThirdPartyAudience)
    }
  ],
  "nextPageToken": string
}
フィールド
firstAndThirdPartyAudiences[]

object (FirstAndThirdPartyAudience)

自社オーディエンスと第三者オーディエンスのリスト。オーディエンス サイズのプロパティは含まれません。

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

string

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

認可スコープ

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

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

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