Method: firstAndThirdPartyAudiences.list

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズです。 1200 の値にしてください。指定しない場合のデフォルトは 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 の概要をご覧ください。