- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- PoiSearchTerms
- BusinessChainSearchTerms
- GeoRegionSearchTerms
- רוצים לנסות?
חיפוש אפשרויות טירגוט מסוג נתון על סמך מונחי החיפוש הנתונים.
בקשת HTTP
POST https://displayvideo.googleapis.com/v2/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 |
שאילתת החיפוש באזור הגיאוגרפי הרצוי. השאילתה יכולה להיות קידומת, למשל "New Yor", "Seattle", "USA" וכו'. |