Method: targetingTypes.targetingOptions.search

ค้นหาตัวเลือกการกำหนดเป้าหมายประเภทหนึ่งๆ ตามข้อความค้นหาที่ระบุ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง 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

โทเค็นที่ระบุหน้าผลการค้นหาที่เซิร์ฟเวอร์ควรแสดง โดยปกติแล้ว ค่านี้คือค่าของ nextPageToken ที่แสดงผลจากการเรียกใช้เมธอด targetingOptions.search ก่อนหน้านี้ หากไม่ระบุ ระบบจะแสดงหน้าแรกของผลการค้นหา
ฟิลด์สหภาพ 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

โทเค็นสําหรับดึงข้อมูลหน้าถัดไปของผลการค้นหา ส่งค่านี้ในช่อง pageToken ในการเรียกใช้เมธอด targetingOptions.search ครั้งถัดไปเพื่อดึงข้อมูลหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

PoiSearchTerms

ข้อความค้นหาสําหรับตัวเลือกการกําหนดเป้าหมายจุดที่น่าสนใจ

การแสดง JSON 
{
  "poiQuery": string
}
ช่อง
poiQuery

string

คําค้นหาชื่อ จุดที่น่าสนใจ ที่อยู่ หรือพิกัดของจุดที่น่าสนใจที่ต้องการ คําค้นหาอาจเป็นคำนำหน้า เช่น "Times squar", "40.7505045,-73.99562", "315 W 44th St" ฯลฯ

BusinessChainSearchTerms

ข้อความค้นหาสําหรับตัวเลือกการกําหนดเป้าหมายเชนธุรกิจ

ควรป้อนข้อมูลอย่างน้อย 1 ฟิลด์

การแสดง JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
ช่อง
businessChainQuery

string

คําค้นหาสําหรับเครือธุรกิจที่ต้องการ คําค้นหาต้องเป็นชื่อเต็มของธุรกิจ เช่น "KFC" "mercedes-benz"
regionQuery

string

คําค้นหาสำหรับภูมิภาคทางภูมิศาสตร์ที่ต้องการ เช่น "ซีแอตเทิล" "สหรัฐอเมริกา"

GeoRegionSearchTerms

ค้นหาข้อความสำหรับตัวเลือกการกำหนดเป้าหมายตามภูมิภาค

การแสดง JSON 
{
  "geoRegionQuery": string
}
ช่อง
geoRegionQuery

string

คําค้นหาสําหรับภูมิภาคทางภูมิศาสตร์ที่ต้องการ คําค้นหาอาจเป็นคำนำหน้า เช่น "New Yor", "Seattle", "USA" ฯลฯ