Method: advertisers.reachForecast.retrievePlannableProducts

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

בקשת HTTP

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

פלט בלבד. השם שמשויך למוצר הפרסום. לדוגמה: 'קמפיין לעידוד צפייה בסרטונים'.

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 מקסימלי לרכישה.