Method: lookalikeAudiences.list

類似オーディエンスを一覧表示します。

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v5/lookalikeAudiences

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • lookalikeAudienceId（デフォルト）
  • displayName

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

string

類似オーディエンス フィールドでフィルタできます。

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

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

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

  • displayName

例:

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

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

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

string (int64 format)

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

string (int64 format)

取得した類似オーディエンスにアクセスできる広告主の ID。
相互に排他的なフィールドの終了。

リクエストの本文

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

レスポンスの本文

LookalikeAudienceService.ListLookalikeAudiences のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (LookalikeAudience)

類似オーディエンスのリスト。

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

string

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

認可スコープ

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

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

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