Method: targetingTypes.targetingOptions.list

指定したタイプのターゲティング オプションをリストします。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1beta2/targetingTypes/{targetingType}/targetingOptions

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

パスパラメータ

パラメータ
targetingType

enum (TargetingType)

必須。リストするターゲティング オプションのタイプ。

次の値が利用できます。

  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_USER_REWARDED_CONTENT
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID

クエリ パラメータ

パラメータ
advertiserId

string (int64 format)

必須。このリクエストの対象となる広告主です。

pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • targetingOptionId(デフォルト)

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

filter

string

ターゲティング オプションのプロパティによるフィルタリングを許可します。

サポートされる構文:

  • フィルタ式は 1 つ以上の制限で構成されます。
  • 制限は OR 論理演算子で組み合わせることができます。
  • 制限の形式は {field} {operator} {value} です。
  • 演算子は「=」(等号)にする必要があります。
  • サポートされているフィールド:
    • carrierAndIspDetails.type
    • geoRegionDetails.geoRegionType
    • targetingOptionId

例:

  • サブタイプ GEO_REGION_TYPE_COUNTRY または GEO_REGION_TYPE_STATE に属するすべての GEO REGION ターゲティング オプション: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"
  • サブタイプ CARRIER_AND_ISP_TYPE_CARRIER に属するすべての CARRIER AND ISP ターゲティング オプション: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"

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

リクエスト本文

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

レスポンスの本文

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

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

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

object (TargetingOption)

ターゲティング オプションのリスト。

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

nextPageToken

string

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

認可スコープ

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

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

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