Method: advertisers.reachForecast.generateReachForecast

Membuat perkiraan jangkauan untuk konfigurasi penargetan dan pengiklan tertentu.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
advertiserId

string (int64 format)

Wajib. ID pengiklan yang akan menjalankan kampanye yang direncanakan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "targeting": {
    object (Targeting)
  },
  "campaignDuration": {
    object (CampaignDuration)
  },
  "currencyCode": string,
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "minEffectiveFrequency": integer
}
Kolom
targeting

object (Targeting)

Wajib. Parameter penargetan kampanye yang direncanakan.
campaignDuration

object (CampaignDuration)

Wajib. Durasi kampanye yang direncanakan.
currencyCode

string

Wajib. Kode mata uang untuk paket dalam format ISO 4217.
plannedProducts[]

object (PlannedProduct)

Wajib. Daftar item baris yang akan disertakan dalam perkiraan.
minEffectiveFrequency

integer

Opsional. Frekuensi efektif minimum untuk metrik jangkauan yang dilaporkan. Ini adalah jumlah minimum iklan yang harus dilihat pelanggan agar dianggap efektif. Setelan ini hanya memengaruhi pelaporan.

Harus antara 1 dan 10, inklusif. Jika tidak ditentukan, nilai default 1 akan diterapkan.

Isi respons

Pesan respons untuk ReachForecastService.GenerateReachForecast.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "onTargetAudienceMetrics": {
    object (OnTargetAudienceMetrics)
  },
  "reachCurve": {
    object (ReachCurve)
  }
}
Kolom
onTargetAudienceMetrics

object (OnTargetAudienceMetrics)

Estimasi ukuran audiens untuk geografi yang ditargetkan.
reachCurve

object (ReachCurve)

Kurva perkiraan yang dihasilkan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

Penargetan

Setelan penargetan untuk kampanye yang direncanakan.

Representasi JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (PlannableAgeRange),
  "genders": [
    enum (Gender)
  ],
  "devices": [
    enum (DeviceType)
  ]
}
Kolom
plannableLocationIds[]

string (int64 format)

Wajib. ID lokasi yang dapat direncanakan untuk ditargetkan.

Lokasi yang dapat direncanakan dapat diambil menggunakan metode reachForecast.retrievePlannableLocations.
ageRange

enum (PlannableAgeRange)

Opsional. Rentang usia yang akan ditargetkan.
genders[]

enum (Gender)

Opsional. Opsi gender yang akan ditargetkan.
devices[]

enum (DeviceType)

Opsional. Perangkat yang akan ditargetkan.

CampaignDuration

Durasi rencana jangkauan.

Representasi JSON 
{

  // Union field duration can be only one of the following:
  "durationDays": integer,
  "dateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field duration.
}
Kolom
Kolom union duration. Pilihan durasi kampanye. duration hanya dapat berupa salah satu dari berikut:
durationDays

integer

Wajib. Jumlah hari yang dicakup oleh paket.
dateRange

object (DateRange)

Wajib. Rentang tanggal yang dicakup oleh rencana.

PlannedProduct

Konfigurasi untuk produk tertentu dalam paket.

Representasi JSON 
{
  "plannableProductCode": string,
  "budgetMicros": string,
  "advancedProductTargeting": {
    object (AdvancedProductTargeting)
  }
}
Kolom
plannableProductCode

string

Wajib. Kode untuk produk, misalnya "VIDEO_REACH_CAMPAIGN".
budgetMicros

string (int64 format)

Wajib. Anggaran untuk produk ini dalam satuan mikro.
advancedProductTargeting

object (AdvancedProductTargeting)

Opsional. Penggantian penargetan tingkat item baris opsional.

AdvancedProductTargeting

Penggantian penargetan khusus produk.

Representasi 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)
}
Kolom
surfaceTargetingSettings

object (SurfaceTargetingSettings)

Opsional. Platform yang dapat direncanakan untuk ditargetkan.
targetFrequency

object (TargetFrequency)

Opsional. Frekuensi rata-rata iklan akan ditampilkan kepada orang yang sama selama jangka waktu tertentu.
frequencyCap

object (FrequencyCap)

Opsional. Batas frekuensi untuk produk tertentu.
ageRange

enum (PlannableAgeRange)

Opsional. Rentang usia yang akan ditargetkan.
genders[]

enum (Gender)

Opsional. Opsi gender yang akan ditargetkan.
devices[]

enum (DeviceType)

Opsional. Perangkat yang akan ditargetkan.
userInterestIds[]

string

Opsional. ID minat pengguna yang akan ditargetkan.

Minat pengguna yang dapat direncanakan dapat diambil menggunakan metode reachForecast.retrievePlannableUserInterests.
userListIds[]

string

Opsional. ID daftar pengguna yang akan ditargetkan.

Daftar pengguna yang dapat direncanakan dapat diambil menggunakan metode reachForecast.retrievePlannableUserInterests.
youtubeSelectSettings

object (YouTubeSelectSettings)

Opsional. Setelan YouTube Select.
dateRange

object (DateRange)

Opsional. Rentang tanggal yang akan ditargetkan.
plannableLocationIds[]

string (int64 format)

Opsional. ID lokasi yang dapat direncanakan untuk ditargetkan.
network

enum (PlannableNetwork)

Opsional. Jaringan yang akan ditargetkan.

SurfaceTargetingSettings

Pilihan penargetan platform.

Representasi JSON 
{
  "surfaces": [
    enum (PlannableSurface)
  ]
}
Kolom
surfaces[]

enum (PlannableSurface)

Opsional. Platform yang akan ditargetkan.

YouTubeSelectSettings

Setelan untuk Grup Channel YouTube Select.

Representasi JSON 
{
  "lineupId": string
}
Kolom
lineupId

string (int64 format)

Opsional. ID Grup Channel YouTube Select.

OnTargetAudienceMetrics

Estimasi ukuran audiens untuk geografi yang ditargetkan.

Representasi JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Kolom
youtubeAudienceSize

string (int64 format)

Estimasi ukuran audiens YouTube.
censusAudienceSize

string (int64 format)

Ukuran audiens berdasarkan data sensus area geografis yang ditargetkan.

ReachCurve

Kurva jangkauan yang dihasilkan.

Representasi JSON 
{
  "reachForecasts": [
    {
      object (ReachForecast)
    }
  ]
}
Kolom
reachForecasts[]

object (ReachForecast)

Titik di sepanjang kurva, diurutkan berdasarkan biaya.

ReachForecast

Satu titik dalam kurva jangkauan.

Representasi JSON 
{
  "costMicros": string,
  "plannedProductReachForecasts": [
    {
      object (PlannedProductReachForecast)
    }
  ],
  "forecast": {
    object (PlannedProductForecast)
  }
}
Kolom
costMicros

string (int64 format)

Total biaya untuk titik ini dalam mikro.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Perincian untuk masing-masing produk pada titik biaya ini.
forecast

object (PlannedProductForecast)

Perkiraan gabungan untuk seluruh rencana.

PlannedProductReachForecast

Perkiraan performa untuk produk tertentu.

Representasi JSON 
{
  "costMicros": string,
  "plannableProductCode": string,
  "plannedProductForecast": {
    object (PlannedProductForecast)
  }
}
Kolom
costMicros

string (int64 format)

Biaya dalam mikro untuk produk ini.
plannableProductCode

string

Kode untuk produk.
plannedProductForecast

object (PlannedProductForecast)

Metrik performa untuk produk.

PlannedProductForecast

Metrik performa untuk titik perkiraan.

Representasi JSON 
{
  "onTargetReach": string,
  "onTargetImpressions": string,
  "trueviewViews": string,
  "totalReach": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Kolom
onTargetReach

string (int64 format)

Jumlah pengguna unik yang dijangkau yang cocok dengan definisi sesuai target.
onTargetImpressions

string (int64 format)

Jumlah tayangan iklan sesuai target.
trueviewViews

string (int64 format)

Jumlah penayangan TrueView.
totalReach

string (int64 format)

Jumlah total pengguna unik yang dijangkau.
totalImpressions

string (int64 format)

Jumlah total tayangan.
viewableImpressions

string (int64 format)

Jumlah tayangan terlihat.
onTargetCoviewReach

string (int64 format)

Jumlah orang unik yang dijangkau yang cocok dengan definisi sesuai target, termasuk penonton bersama.
totalCoviewReach

string (int64 format)

Jumlah total orang unik yang dijangkau, termasuk penonton bersama.
onTargetCoviewImpressions

string (int64 format)

Jumlah tayangan iklan sesuai target termasuk penonton bersama.
totalCoviewImpressions

string (int64 format)

Jumlah total tayangan iklan termasuk penonton bersama.