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 שהוחזר מהקריאה הקודמת ל-method 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.

PoiSearchTerms

מונחי חיפוש לאפשרויות טירגוט של נקודות עניין.

ייצוג JSON 
{
  "poiQuery": string
}
שדות
poiQuery

string

שאילתת החיפוש של שם נקודת העניין, הרחוב או הקואורדינטות של נקודת העניין הרצויה. השאילתה יכולה להיות תחילית, למשל: "Times squar", "40.7505045,-73.99562", "315 W 44th St" וכו'

BusinessChainSearchTerms

מונחי חיפוש לאפשרויות טירגוט של רשת עסקית.

יש למלא לפחות אחד מהשדות.

ייצוג JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
שדות
businessChainQuery

string

שאילתת החיפוש של שרשרת העסק הרצויה. השאילתה צריכה לכלול את השם המלא של העסק, לדוגמה: 'KFC', 'mercedes-benz'.
regionQuery

string

שאילתת החיפוש של האזור הגיאוגרפי הרצוי, למשל: "Seattle", "United States".

GeoRegionSearchTerms

מונחי חיפוש לאפשרויות טירגוט לפי אזור גיאוגרפי.

ייצוג JSON 
{
  "geoRegionQuery": string
}
שדות
geoRegionQuery

string

שאילתת החיפוש עבור האזור הגיאוגרפי הרצוי. השאילתה יכולה להיות תחילית, למשל: "New Yor", "Seattle", "USA" וכו'