Method: advertisers.reachForecast.generateReachForecast

پیش‌بینی دسترسی را برای تبلیغ‌کننده و پیکربندی هدف‌یابی مشخصی تولید می‌کند.

درخواست HTTP

POST https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/reachForecast:generateReachForecast

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

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

پارامترها
advertiserId

string (int64 format)

الزامی. شناسه آگهی‌دهنده‌ای که پویش برنامه‌ریزی‌شده را اجرا خواهد کرد.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
فیلدها
targeting

object (Targeting)

الزامی. پارامترهای هدف‌یابی پویش برنامه‌ریزی‌شده.
campaignDuration

object (CampaignDuration)

الزامی. مدت پویش برنامه‌ریزی‌شده.
currencyCode

string

الزامی. کد واحد پول برای طرح در قالب ISO 4217.
plannedProducts[]

object (PlannedProduct)

الزامی. فهرست موارد سطری برای گنجاندن در پیش‌بینی.
minEffectiveFrequency

integer

اختیاری. حداقل فراوانی مؤثر برای سنجه‌های دسترسی گزارش‌شده. این کمترین تعداد دفعاتی است که مشتری باید درمعرض آگهی قرار گیرد تا آگهی مؤثر تلقی شود. این تنظیم فقط بر گزارش‌دهی تأثیر می‌گذارد.

باید برابر یا بین «۱» و «۱۰»، فراگیر باشد. اگر مشخص نشده باشد، مقدار پیش‌فرض ۱ اعمال می‌شود.

بدنه پاسخ

پیام پاسخ برای ReachForecastService.GenerateReachForecast.

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
فیلدها
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

اندازه تخمینی مخاطبان برای جغرافیای هدف.
reachCurve

object (ReachCurve)

منحنی پیش‌بینی تولیدشده.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به OAuth 2.0 Overview مراجعه کنید.

هدف‌گیری

تنظیمات هدف‌یابی برای پویش برنامه‌ریزی‌شده.

نمایش JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
فیلدها
plannableLocationIds[]

string (int64 format)

الزامی. شناسه‌های مکان‌های قابل‌برنامه‌ریزی برای هدف‌یابی.

مکان‌های قابل‌برنامه‌ریزی را می‌توان بااستفاده از روش reachForecast.retrievePlannableLocations بازیابی کرد.
ageRange

enum (PlannableAgeRange)

اختیاری. محدوده سنی برای هدف‌یابی.
genders[]

enum (Gender)

اختیاری. گزینه‌های جنسیت برای هدف‌یابی.
devices[]

enum (DeviceType)

اختیاری. دستگاه‌هایی که باید هدف‌یابی شوند.

CampaignDuration

مدت طرح دسترسی.

نمایش JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of mutually exclusive fields.
}
فیلدها
انتخاب مدت کمپین. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
durationDays

integer

الزامی. تعداد روزهایی که طرح پوشش می‌دهد.
dateRange

object (DateRange)

الزامی. محدوده تاریخی که طرح پوشش می‌دهد.
پایان فیلدهای متقابلاً انحصاری.

PlannedProduct

پیکربندی برای محصولی خاص در طرح.

نمایش JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
فیلدها
plannableProductCode

string

الزامی. کد محصول، مثلاً «VIDEO_REACH_CAMPAIGN».
budgetMicros

string (int64 format)

الزامی. بودجه این محصول به میکرو.
advancedProductTargeting

object (AdvancedProductTargeting)

اختیاری. لغو کردن‌های اختیاری هدف‌یابی سطح ردیف.

AdvancedProductTargeting

لغو هدف‌یابی مختص محصول.

نمایش JSON 
{
  "surfaceTargetingSettings": {
    object (SurfaceTargetingSettings)
  },
  "targetFrequency": {
    object (TargetFrequency)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ],
  "userInterestIds": [
    string
  ],
  "userListIds": [
    string
  ],
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  },
  "dateRange": {
    object (DateRange)
  },
  "plannableLocationIds": [
    string
  ],
  "network": enum (PlannableNetwork)
}
فیلدها
surfaceTargetingSettings

object (SurfaceTargetingSettings)

اختیاری. سطوح قابل‌برنامه‌ریزی برای هدف‌یابی.
targetFrequency

object (TargetFrequency)

اختیاری. تعداد دفعات میانگینی که آگهی‌ها درطول دوره زمانی مشخصی به یک فرد نشان داده خواهد شد.
frequencyCap

object (FrequencyCap)

اختیاری. حد بسامد برای محصول خاص.
ageRange

enum (PlannableAgeRange)

اختیاری. محدوده سنی برای هدف‌یابی.
genders[]

enum (Gender)

اختیاری. گزینه‌های جنسیت برای هدف‌یابی.
devices[]

enum (DeviceType)

اختیاری. دستگاه‌هایی که باید هدف‌یابی شوند.
userInterestIds[]

string

اختیاری. شناسه‌های علایق کاربر برای هدف‌یابی.

علایق کاربر قابل‌برنامه‌ریزی را می‌توان بااستفاده از روش reachForecast.retrievePlannableUserInterests بازیابی کرد.
userListIds[]

string

اختیاری. شناسه‌های فهرست کاربر برای هدف‌یابی.

فهرست‌های کاربران قابل‌برنامه‌ریزی را می‌توان بااستفاده از روش reachForecast.retrievePlannableUserInterests بازیابی کرد.
youtubeSelectSettings

object (YouTubeSelectSettings)

اختیاری. تنظیمات YouTube Select.
dateRange

object (DateRange)

اختیاری. محدوده تاریخ برای هدف‌یابی.
plannableLocationIds[]

string (int64 format)

اختیاری. شناسه‌های مکان قابل‌برنامه‌ریزی برای هدف‌یابی.
network

enum (PlannableNetwork)

اختیاری. شبکه موردنظر برای هدف‌یابی.

SurfaceTargetingSettings

انتخاب هدف‌یابی سطح.

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

enum (PlannableSurface)

اختیاری. سطوح هدف.

YouTubeSelectSettings

تنظیمات برای «مجموعه‌های YouTube Select».

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

string (int64 format)

اختیاری. شناسه «مجموعه YouTube Select».

OnTargetAudienceMetrics

اندازه تخمینی مخاطب برای جغرافیای هدف‌یابی‌شده.

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

string (int64 format)

اندازه تخمینی مخاطبان YouTube.
censusAudienceSize

string (int64 format)

اندازه مخاطب براساس داده‌های سرشماری جغرافیای هدف‌یابی‌شده.

ReachCurve

منحنی دسترسی تولیدشده.

نمایش JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
فیلدها
reachForecasts[]

object (ReachForecast)

نقاط روی منحنی، مرتب‌شده براساس هزینه.

ReachForecast

یک نقطه در منحنی دسترسی.

نمایش JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
فیلدها
costMicros

string (int64 format)

هزینه کل برای این نقطه به میکرو.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

تفکیک محصولات تکی در این نقطه هزینه.
forecast

object (PlannedProductForecast)

پیش‌بینی انبوهشی برای کل طرح.

PlannedProductReachForecast

پیش‌بینی عملکرد برای محصولی خاص.

نمایش JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
فیلدها
costMicros

string (int64 format)

هزینه این محصول به میکرو.
plannableProductCode

string

کد محصول.
plannedProductForecast

object (PlannedProductForecast)

سنجه‌های عملکرد برای محصول.

PlannedProductForecast

سنجه‌های عملکرد برای نقطه پیش‌بینی.

نمایش JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
فیلدها
onTargetReach

string (int64 format)

تعداد افراد یکتایی که به آن‌ها دسترسی پیدا شده است و با تعریف هدف مطابقت دارند.
onTargetImpressions

string (int64 format)

تعداد ظهور به مخاطبان هدف.
trueviewViews

string (int64 format)

تعداد بازدیدهای TrueView.
totalReach

string (int64 format)

تعداد کل افراد غیرتکراری که به آن‌ها دسترسی پیدا کرده‌اید.
totalImpressions

string (int64 format)

تعداد کل ظهورها.
viewableImpressions

string (int64 format)

تعداد ظهورهای قابل‌مشاهده.
onTargetCoviewReach

string (int64 format)

تعداد افراد غیرتکراری که به آن‌ها دسترسی پیدا شده است و با تعریف هدف مطابقت دارند، ازجمله تماشاگران مشترک.
totalCoviewReach

string (int64 format)

تعداد کل افراد غیرتکراری که به آن‌ها دسترسی پیدا شده است، ازجمله تماشاگران مشترک.
onTargetCoviewImpressions

string (int64 format)

تعداد ظهورهای نشان‌داده‌شده به مخاطبان هدف با احتساب بینندگان مشترک.
totalCoviewImpressions

string (int64 format)

تعداد کل ظهورها با احتساب بینندگان مشترک.