Method: advertisers.reachForecast.retrievePlannableProducts

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/reachForecast:retrievePlannableProducts

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

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

פרמטרים
advertiserId

string (int64 format)

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

פרמטרים של שאילתה

פרמטרים
plannableLocationId

string

חובה. המזהה של המיקום שניתן לתכנון.

גוף הבקשה

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

גוף התשובה

תגובה ל-reachForecast.retrievePlannableProducts

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

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

object (ProductMetadata)

פלט בלבד. רשימת המטא-נתונים של המוצר שמציגה את אפשרויות הטירגוט.

היקפי הרשאות

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

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

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

ProductMetadata

מטא-נתונים של מוצר שניתן לתכנון.

ייצוג ב-JSON 
{
  "plannableProductDescription": string,
  "plannableProductCode": string,
  "plannableTargeting": {
    object (PlannableTargeting)
  },
  "displayName": string,
  "plannableProductCoreAttributes": {
    object (PlannableProductCoreAttributes)
  }
}
שדות
plannableProductDescription

string

פלט בלבד. תיאור בטקסט פשוט של חבילת הפרסום.
plannableProductCode

string

פלט בלבד. קוד המוצר שניתן לתכנון (למשל, "YOUTUBE_REACH_MIX").
plannableTargeting

object (PlannableTargeting)

פלט בלבד. יכולות הטירגוט שזמינות למוצר הזה.
displayName

string

פלט בלבד. השם שמשויך לחבילת הפרסום. לדוגמה: "קמפיין למיקסום צפיות (VVC)".
plannableProductCoreAttributes

object (PlannableProductCoreAttributes)

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

PlannableTargeting

יכולות טירגוט למוצר נתון.

ייצוג ב-JSON 
{
  "ageRanges": [
    enum (PlannableAgeRange)
  ],
  "surfaceTargetingCombinations": {
    object (SurfaceTargetingCombinations)
  },
  "genders": [
    enum (Gender)
  ],
  "networks": [
    enum (PlannableNetwork)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "youtubeSelectLineups": [
    {
      object (YouTubeSelectLineUp)
    }
  ],
  "defaultYoutubeSelectLineup": {
    object (YouTubeSelectLineUp)
  }
}
שדות
ageRanges[]

enum (PlannableAgeRange)

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

object (SurfaceTargetingCombinations)

פלט בלבד. שילובים של פלטפורמות שאפשר לטרגט בחבילת הפרסום.
genders[]

enum (Gender)

פלט בלבד. מגדרים שאפשר לטרגט בחבילת הפרסום.
networks[]

enum (PlannableNetwork)

פלט בלבד. רשתות שאפשר לטרגט בחבילת הפרסום.
devices[]

enum (DeviceType)

פלט בלבד. המכשירים שאפשר לטרגט בחבילת הפרסום.
youtubeSelectLineups[]

object (YouTubeSelectLineUp)

פלט בלבד. חבילות ערוצים של YouTube Select שאפשר לטרגט במוצר הפרסום.
defaultYoutubeSelectLineup

object (YouTubeSelectLineUp)

פלט בלבד. חבילת הערוצים של YouTube Select שמוגדרת כברירת מחדל למוצר הזה, אם רלוונטי.

SurfaceTargetingCombinations

כללי טירגוט לפלטפורמות.

ייצוג ב-JSON 
{
  "availableSurfaceTypes": [
    enum (PlannableSurface)
  ],
  "validSurfaceCombinations": [
    {
      object (SurfaceTargetingCombination)
    }
  ],
  "defaultSurfaceTypes": [
    enum (PlannableSurface)
  ]
}
שדות
availableSurfaceTypes[]

enum (PlannableSurface)

פלט בלבד. סוגי הפלטפורמות הזמינות.
validSurfaceCombinations[]

object (SurfaceTargetingCombination)

פלט בלבד. שילובים תקינים של פלטפורמות שאפשר לבחור ביחד.
defaultSurfaceTypes[]

enum (PlannableSurface)

פלט בלבד. סוגי המשטחים שמוגדרים כברירת מחדל למוצר הזה.

SurfaceTargetingCombination

שילוב חוקי של פלטפורמות.

ייצוג ב-JSON 
{
  "choices": [
    enum (PlannableSurface)
  ]
}
שדות
choices[]

enum (PlannableSurface)

פלט בלבד. שילוב של פלטפורמות.

YouTubeSelectLineUp

חבילת ערוצים של YouTube Select שניתן לתכנן לטירגוט מוצרים.

ייצוג ב-JSON 
{
  "lineupId": string,
  "displayName": string
}
שדות
lineupId

string (int64 format)

פלט בלבד. המזהה של חבילת הערוצים של YouTube Select.
displayName

string

פלט בלבד. השם המוצג של חבילת הערוצים של YouTube Select.

PlannableProductCoreAttributes

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

ייצוג ב-JSON 
{
  "productCategory": enum (PlannableProductCategory),
  "buyingMethod": enum (PlannableBuyingMethod),
  "costModel": enum (PlannableCostModel)
}
שדות
productCategory

enum (PlannableProductCategory)

פלט בלבד. קטגוריית המוצר.
buyingMethod

enum (PlannableBuyingMethod)

פלט בלבד. שיטת הקנייה.
costModel

enum (PlannableCostModel)

פלט בלבד. מודל העלות.

PlannableBuyingMethod

שיטת הקנייה של מוצר שניתן לתכנון.

טיפוסים בני מנייה (enum)
PLANNABLE_BUYING_METHOD_UNSPECIFIED לא צוין.
PLANNABLE_BUYING_METHOD_AUCTION מכרז.
PLANNABLE_BUYING_METHOD_RESERVATION הזמנה.

PlannableCostModel

מודל העלות של מוצר שניתן לתכנון.

טיפוסים בני מנייה (enum)
PLANNABLE_COST_MODEL_UNSPECIFIED לא צוין.
PLANNABLE_COST_MODEL_CPM לאלף חשיפות' (CPM).
PLANNABLE_COST_MODEL_CPV עלות לצפייה (CPV).
PLANNABLE_COST_MODEL_CPC עלות לקליק.
PLANNABLE_COST_MODEL_CPA מקסימלי לרכישה.