Method: targetingTypes.targetingOptions.search

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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

צריך לאכלס לפחות אחד מהשדות.

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

string

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

string

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

GeoRegionSearchTerms

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

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

string

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