Method: targetingTypes.targetingOptions.search

חיפוש אפשרויות טירגוט מסוג נתון על סמך מונחי החיפוש הנתונים.

בקשת HTTP

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

שאילתת החיפוש עבור האזור הגיאוגרפי הרצוי, למשל "פתח תקווה", "ישראל".

GeoRegionSearchTerms

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

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

string

שאילתת החיפוש באזור הגיאוגרפי הרצוי. השאילתה יכולה להיות קידומת, למשל "ניו יורק", "סיאטל", "ישראל" וכו'.