Method: targetingTypes.targetingOptions.search

根据给定的搜索字词搜索给定类型的定位选项。

HTTP 请求

POST https://displayvideo.googleapis.com/v3/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

用于搜索所需地图注点名称、街道地址或坐标的搜索查询。查询可以是前缀，例如“时代广场”“40.7505045,-73.99562”“315 W 44th St”等。

BusinessChainSearchTerms

搜索连锁企业定位选项的字词。

应至少填充其中一个字段。

JSON 表示法 
{
  "businessChainQuery": string,
  "regionQuery": string
}
字段
businessChainQuery

string

用于搜索所需商家连锁的搜索查询。查询必须是商家的全称，例如“肯德基”“奔驰”。
regionQuery

string

用于搜索所需地理区域的搜索查询，例如“西雅图”“美国”。

GeoRegionSearchTerms

用于搜索地理区域定位选项的搜索字词。

JSON 表示法 
{
  "geoRegionQuery": string
}
字段
geoRegionQuery

string

对所需地理区域的搜索查询。查询可以是前缀，例如“New Yor”“Seattle”“USA”等。