Method: targetingTypes.targetingOptions.search

根據指定的搜尋字詞，搜尋指定類型的指定目標選項。

HTTP 要求

POST https://displayvideo.googleapis.com/v2/targetingTypes/{targetingType}/targetingOptions:search

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

路徑參數

參數
targetingType

enum (TargetingType)

必要欄位。要擷取的指定目標選項類型。

可接受的值如下：

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
欄位
advertiserId

string (int64 format)

必要欄位。提出這項要求的廣告主。
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如果未指定，則預設值為 100。如果指定無效值，則傳回錯誤代碼 INVALID_ARGUMENT。
pageToken

string

用於識別伺服器應傳回結果頁面的符記。一般而言，這是先前呼叫 targetingOptions.search 方法後傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
聯集欄位 search_terms。用於搜尋指定目標選項的查詢。search_terms 只能填寫一個欄位，且必須對應至 targeting_type。search_terms 只能採用下列其中一種設定：
poiSearchTerms

object (PoiSearchTerms)

搜尋點指定目標選項的搜尋字詞。只有在 targetingType 為 TARGETING_TYPE_POI 時才能使用。
businessChainSearchTerms

object (BusinessChainSearchTerms)

連鎖店指定目標選項的搜尋字詞。只有在 targetingType 為 TARGETING_TYPE_BUSINESS_CHAIN 時才能使用。
geoRegionSearchTerms

object (GeoRegionSearchTerms)

指定地理區域選項的搜尋字詞。只有在 targetingType 為 TARGETING_TYPE_GEO_REGION 時才能使用。

回應主體

「targetingOptions.search」的回應訊息。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
欄位
targetingOptions[]

object (TargetingOption)

符合搜尋條件的指定目標選項清單。

如果空白，這份清單就不會顯示。
nextPageToken

string

用於擷取下一頁結果的符記。在對 targetingOptions.search 方法的後續呼叫中，將這個值傳入 pageToken 欄位，擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

PoiSearchTerms

搜尋點指定目標選項的搜尋字詞。

JSON 表示法 
{
  "poiQuery": string
}
欄位
poiQuery

string

所需搜尋點名稱、街道地址或所需搜尋點座標的搜尋查詢。查詢可以是前置字元，例如「Times quar」、「40.7505045,-73.99562」、「315 W 44th St」等等。

BusinessChainSearchTerms

連鎖店指定目標選項的搜尋字詞。

請填寫至少一個欄位。

JSON 表示法 
{
  "businessChainQuery": string,
  "regionQuery": string
}
欄位
businessChainQuery

string

所需連鎖商家的搜尋查詢。查詢必須是商家的完整名稱，例如「KFC」、「mercedes-benz」。
regionQuery

string

目標地理區域的搜尋查詢，例如「西雅圖」、「大州」。

GeoRegionSearchTerms

指定地理區域選項的搜尋字詞。

JSON 表示法 
{
  "geoRegionQuery": string
}
欄位
geoRegionQuery

string

目標地理區域的搜尋查詢。查詢可以是前置字元，例如「New Yor」、「Seattle」、「USA」等。