Method: targetingTypes.targetingOptions.list

列出指定類型的指定目標選項。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

請求的頁面大小。必須介於 1200 之間。如果未指定,則預設為 100。如果指定無效值,則會傳回錯誤代碼 INVALID_ARGUMENT

pageToken

string

這個符記可識別伺服器應傳回的結果頁面。通常,這是先前對 targetingOptions.list 方法的呼叫傳回的 nextPageToken 值。如未指定,系統會傳回第一頁的結果。

orderBy

string

用來排序清單的欄位。可接受的值如下:

  • targetingOptionId (預設)

預設排序順序為遞增。如要針對欄位指定遞減順序,則應於欄位名稱後方加上「desc」後置字串。範例:targetingOptionId desc

filter

string

可依指定選項欄位進行篩選。

支援的語法:

  • 篩選器運算式由一或多個限制組成。
  • 限制可以透過 OR 邏輯運算子合併。
  • 限制的格式為 {field} {operator} {value}
  • 所有欄位都必須使用 EQUALS (=) 運算子。

支援的欄位:

  • carrierAndIspDetails.type
  • geoRegionDetails.geoRegionType
  • targetingOptionId

範例:

  • 屬於子類型 GEO_REGION_TYPE_COUNTRYGEO_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 個半形字元。

詳情請參閱篩選 LIST 要求指南。

要求主體

要求主體必須為空白。

回應主體

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 Overview