- בקשת 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 |
שאילתת החיפוש של האזור הגיאוגרפי הרצוי, למשל: "Seattle", "United States". |
GeoRegionSearchTerms
מונחי חיפוש לאפשרויות טירגוט לפי אזור גיאוגרפי.
ייצוג JSON |
---|
{ "geoRegionQuery": string } |
שדות | |
---|---|
geoRegionQuery |
שאילתת החיפוש עבור האזור הגיאוגרפי הרצוי. השאילתה יכולה להיות תחילית, למשל: "New Yor", "Seattle", "USA" וכו' |