Method: advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list

広告掲載オーダーに割り当てられているターゲティング オプションを一覧表示します。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/insertionOrders/{insertionOrderId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

パスパラメータ

パラメータ
advertiserId

string (int64 format)

必須。広告掲載オーダーが属する広告主の ID。
insertionOrderId

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

例:

  • ID 1 または 2 の AssignedTargetingOption リソース: 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

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

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。