Method: advertisers.reachForecast.retrievePlannableProducts

فهرست محصولاتی را که می‌توان برای یک مکان برنامه‌ریزی کرد، بازیابی می‌کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
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 .

فراداده محصول

فراداده برای یک محصول قابل برنامه‌ریزی.

نمایش 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 )

فقط خروجی. ویژگی‌های اصلی این محصول.

هدف‌گذاری قابل برنامه‌ریزی

هدف قرار دادن قابلیت‌ها برای یک محصول معین.

نمایش 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 )

فقط خروجی. محدوده‌های سنی مجاز و قابل برنامه‌ریزی برای محصول. هدف‌گیری واقعی با نگاشت این محدوده سنی به هدف‌گذاری سنی استاندارد گوگل محاسبه می‌شود.

surfaceTargetingCombinations

object ( SurfaceTargetingCombinations )

فقط خروجی. ترکیبات سطحی قابل هدف‌گیری برای محصول تبلیغاتی.

genders[]

enum ( Gender )

فقط خروجی. جنسیت‌های قابل هدف‌گیری برای محصول تبلیغاتی.

networks[]

enum ( PlannableNetwork )

فقط خروجی. شبکه‌های هدف‌گذاری‌شده برای محصول تبلیغاتی.

devices[]

enum ( DeviceType )

فقط خروجی. دستگاه‌های قابل هدف‌گیری برای محصول تبلیغاتی.

youtubeSelectLineups[]

object ( YouTubeSelectLineUp )

فقط خروجی. لیست‌های منتخب یوتیوب قابل هدف‌گیری برای محصول تبلیغاتی.

defaultYoutubeSelectLineup

object ( YouTubeSelectLineUp )

فقط خروجی. در صورت وجود، فهرست پخش پیش‌فرض YouTube Select برای این محصول.

ترکیبات هدف‌گیری سطحی

قوانین هدف‌گیری سطحی

نمایش JSON 
{
  "availableSurfaceTypes": [
    enum (PlannableSurface)
  ],
  "validSurfaceCombinations": [
    {
      object (SurfaceTargetingCombination)
    }
  ],
  "defaultSurfaceTypes": [
    enum (PlannableSurface)
  ]
}
فیلدها
availableSurfaceTypes[]

enum ( PlannableSurface )

فقط خروجی. انواع سطوح موجود.

validSurfaceCombinations[]

object ( SurfaceTargetingCombination )

فقط خروجی. ترکیب‌های معتبری از سطوح که می‌توانند با هم انتخاب شوند.

defaultSurfaceTypes[]

enum ( PlannableSurface )

فقط خروجی. انواع سطوح پیش‌فرض برای این محصول.

ترکیب هدف‌گیری سطحی

ترکیبی معتبر از سطوح.

نمایش JSON 
{
  "choices": [
    enum (PlannableSurface)
  ]
}
فیلدها
choices[]

enum ( PlannableSurface )

فقط خروجی. ترکیب سطوح.

یوتیوب سلکت‌لاین‌آپ

یک مجموعه منتخب یوتیوب قابل برنامه‌ریزی برای هدف‌گیری محصول.

نمایش JSON 
{
  "lineupId": string,
  "displayName": string
}
فیلدها
lineupId

string ( int64 format)

فقط خروجی. شناسه‌ی فهرست منتخب یوتیوب.

displayName

string

فقط خروجی. نام نمایشی مجموعه منتخب یوتیوب.

ویژگی‌های اصلی محصول قابل برنامه‌ریزی

ویژگی‌های اصلی برای یک محصول قابل برنامه‌ریزی

نمایش JSON 
{
  "productCategory": enum (PlannableProductCategory),
  "buyingMethod": enum (PlannableBuyingMethod),
  "costModel": enum (PlannableCostModel)
}
فیلدها
productCategory

enum ( PlannableProductCategory )

فقط خروجی. دسته بندی محصول.

buyingMethod

enum ( PlannableBuyingMethod )

فقط خروجی. روش خرید.

costModel

enum ( PlannableCostModel )

فقط خروجی. مدل هزینه.

روش خرید قابل برنامه‌ریزی

روش خرید یک محصول قابل برنامه‌ریزی.

انوم‌ها
PLANNABLE_BUYING_METHOD_UNSPECIFIED مشخص نشده است.
PLANNABLE_BUYING_METHOD_AUCTION حراج.
PLANNABLE_BUYING_METHOD_RESERVATION رزرو.

مدل هزینه قابل برنامه‌ریزی

مدل هزینه یک محصول قابل برنامه‌ریزی.

انوم‌ها
PLANNABLE_COST_MODEL_UNSPECIFIED مشخص نشده است.
PLANNABLE_COST_MODEL_CPM سی پی ام.
PLANNABLE_COST_MODEL_CPV سی پی وی
PLANNABLE_COST_MODEL_CPC سی پی سی.
PLANNABLE_COST_MODEL_CPA حسابدار رسمی.