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 リクエストをフィルタするガイドをご覧ください。
結合パラメータ accessor。必須。リクエストがどの DV360 エンティティ内で行われたかを識別します。LIST リクエストは、accessor 内で識別された DV360 エンティティにアクセスできるファーストパーティ オーディエンスとパートナー オーディエンス エンティティのみを返します。accessor は次のいずれかになります。
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 をご覧ください。