Method: advertisers.campaigns.targetingTypes.assignedTargetingOptions.list

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

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/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

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

pageToken

string

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

orderBy

string

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

  • assignedTargetingOptionId(デフォルト)

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

filter

string

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

サポートされる構文:

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

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

  • assignedTargetingOptionId
  • inheritance

例:

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

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

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

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

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

object (AssignedTargetingOption)

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

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

nextPageToken

string

結果の次のページを識別するトークン。結果の次のページを取得するには、この値を後続の ListCampaignAssignedTargetingOptionsRequestpageToken として指定する必要があります。返す assignedTargetingOptions がそれ以上ない場合、このトークンは存在しません。

認可スコープ

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

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

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