Method: advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

指定されたターゲティング タイプのキャンペーンに割り当てられたターゲティング オプションを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns/{campaignId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。キャンペーンが属する広告主の ID。
campaignId

string (int64 format)

必須。割り当てられたターゲティング オプションを一覧表示するキャンペーンの ID。
targetingType

enum (TargetingType)

必須。一覧表示する割り当て済みのターゲティング オプションのタイプを指定します。

サポートされているターゲティング タイプ:

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

  • assignedTargetingOptionId（デフォルト）

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

string

割り当てられたターゲティング オプション フィールドでフィルタできます。

サポートされる構文:

  • フィルタ式は、1 つ以上の制限で構成されます。
  • 制限は、OR 論理演算子で組み合わせることができます。
  • 制限の形式は {field} {operator} {value} です。
  • すべてのフィールドで EQUALS (=) 演算子を使用する必要があります。

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

  • assignedTargetingOptionId
  • inheritance

例:

  • AssignedTargetingOption ID が 1 または 2 のリソース assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"
  • 継承ステータスが NOT_INHERITED または INHERITED_FROM_PARTNER の AssignedTargetingOption リソース inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"

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

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。

リクエストの本文

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

レスポンスの本文

assignedTargetingOptions.list に対するレスポンス メッセージです。

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

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

object (AssignedTargetingOption)

割り当てられたターゲティング オプションのリスト。

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

string

結果の次のページを特定するトークン。この値は、次の ListCampaignAssignedTargetingOptionsRequest で pageToken として指定し、結果の次のページを取得する必要があります。返される assignedTargetingOptions がない場合、このトークンは存在しません。

認可スコープ

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

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

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