Method: advertisers.reachForecast.retrievePlannableLocations

מאחזר את רשימת המדינות שבהן יש תמיכה בתחזיות לגבי היקף החשיפה.

בקשת HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableLocations

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
advertiserId

string (int64 format)

חובה. מזהה המפרסם שרוצים לקבל רשימה של מיקומים שאפשר לתכנן עבורם.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תגובה ל-reachForecast.retrievePlannableLocations

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "plannableLocations": [
    {
      object (PlannableLocation)
    }
  ]
}
שדות
plannableLocations[]

object (PlannableLocation)

פלט בלבד. רשימת המיקומים שאפשר לתכנן בהם.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/display-video

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

PlannableLocation

מיקום שאפשר לתכנן לגביו, שמשמש ליצירת תחזית.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "geoRegionType": enum (GeoRegionType),
  "plannableLocationId": string,
  "regionCode": string,
  "parentPlannableLocationId": string
}
שדות
name

string

פלט בלבד. שם המשאב של המיקום שאפשר לתכנן בו.
displayName

string

פלט בלבד. השם המוצג של המיקום, לדוגמה 'אלג'יריה'.
geoRegionType

enum (GeoRegionType)

פלט בלבד. סוג המיקום.
plannableLocationId

string (int64 format)

פלט בלבד. מזהה המיקום שאפשר לתכנן אליו נסיעה.
regionCode

string

פלט בלבד. קוד האזור של המיקום, לדוגמה DZ לאלג'יריה.
parentPlannableLocationId

string (int64 format)

פלט בלבד. המזהה של המיקום הגיאוגרפי הניתן לתכנון ברמת ההורה, לדוגמה מזהה המדינה עבור מיקומים גיאוגרפיים משניים.