- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- PoiSearchTerms
- BusinessChainSearchTerms
- GeoRegionSearchTerms
- רוצים לנסות?
חיפוש אפשרויות טירגוט מסוג נתון על סמך מונחי החיפוש הנתונים.
בקשת HTTP
POST https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions:search
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
targetingType |
חובה. הסוג של אפשרויות הטירגוט שיש לאחזר. הערכים הקבילים הם:
|
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "advertiserId": string, "pageSize": integer, "pageToken": string, // Union field |
שדות | |
---|---|
advertiserId |
חובה. המפרסם, הבקשה הזו נשלחת בהקשר שלו. |
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
שדה איחוד search_terms . שאילתות שלפיהן יש לחפש אפשרויות מיקוד. ניתן למלא רק שדה אחד ב-search_terms , והוא חייב להיות תואם לשדה targeting_type . הערך של search_terms יכול להיות רק אחת מהאפשרויות הבאות: |
|
poiSearchTerms |
מונחי חיפוש לאפשרויות טירגוט לפי נקודות עניין. אפשר להשתמש במאפיין רק אם הערך של |
businessChainSearchTerms |
חיפוש לפי אפשרויות לטירגוט 'שרשרת עסקית'. אפשר להשתמש במאפיין רק אם הערך של |
geoRegionSearchTerms |
מונחי חיפוש לאפשרויות של טירגוט לפי אזור גיאוגרפי. אפשר להשתמש במאפיין רק אם הערך של |
גוף התגובה
הודעת תשובה לגבי targetingOptions.search
.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"targetingOptions": [
{
object ( |
שדות | |
---|---|
targetingOptions[] |
רשימה של אפשרויות טירגוט שתואמות לקריטריונים של החיפוש. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/display-video
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
PoiSearchTerms
מונחי חיפוש לאפשרויות טירגוט לפי נקודות עניין.
ייצוג JSON |
---|
{ "poiQuery": string } |
שדות | |
---|---|
poiQuery |
שאילתת החיפוש של השם של נקודת העניין, הרחוב או הקואורדינטה של נקודת העניין הרצויה. השאילתה יכולה להיות קידומת, למשל "Times squar" , "40.7505045,-73.99562" , "315 W 44th St" וכו'. |
BusinessChainSearchTerms
חיפוש לפי אפשרויות לטירגוט 'שרשרת עסקית'.
יש לאכלס לפחות אחד מהשדות.
ייצוג JSON |
---|
{ "businessChainQuery": string, "regionQuery": string } |
שדות | |
---|---|
businessChainQuery |
שאילתת החיפוש של הרשת העסקית הרצויה. השאילתה חייבת להיות השם המלא של העסק, לדוגמה "KFC", "mercedes-benz". |
regionQuery |
שאילתת החיפוש עבור האזור הגיאוגרפי הרצוי, למשל "פתח תקווה", "ישראל". |
GeoRegionSearchTerms
מונחי חיפוש לאפשרויות של טירגוט לפי אזור גיאוגרפי.
ייצוג JSON |
---|
{ "geoRegionQuery": string } |
שדות | |
---|---|
geoRegionQuery |
שאילתת החיפוש באזור הגיאוגרפי הרצוי. השאילתה יכולה להיות קידומת, למשל "ניו יורק", "סיאטל", "ישראל" וכו'. |