Method: advertisers.reachForecast.retrievePlannableLocations

אחזור של רשימת המדינות שבהן יש תמיכה בתחזיות פוטנציאל החשיפה.

בקשת HTTP

GET https://displayvideo.googleapis.com/v5/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)

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