Method: targetingTypes.targetingOptions.search

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

คำขอ HTTP

POST https://displayvideo.googleapis.com/v3/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 ครั้งก่อน หากไม่ได้ระบุ ระบบจะแสดงผลหน้าแรกของผลการค้นหา
ฟิลด์ Union search_terms คําค้นหาที่ใช้ค้นหาตัวเลือกการกําหนดเป้าหมาย กรอกข้อมูลได้เพียง 1 ฟิลด์ใน 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

คำค้นหาสำหรับชื่อจุดที่น่าสนใจ ที่อยู่ หรือพิกัดของจุดที่น่าสนใจที่ต้องการ การค้นหาอาจเป็นคำนำหน้า เช่น "ไทม์สแควร์" "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" เป็นต้น