Method: customers.generateReachForecast

Menghasilkan perkiraan jangkauan untuk penargetan / kombinasi produk tertentu.

Daftar error yang ditampilkan: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

Permintaan HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}:generateReachForecast

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "campaignDuration": {
    object (CampaignDuration)
  },
  "cookieFrequencyCapSetting": {
    object (FrequencyCap)
  },
  "targeting": {
    object (Targeting)
  },
  "plannedProducts": [
    {
      object (PlannedProduct)
    }
  ],
  "forecastMetricOptions": {
    object (ForecastMetricOptions)
  },
  "currencyCode": string,
  "cookieFrequencyCap": integer,
  "minEffectiveFrequency": integer,
  "effectiveFrequencyLimit": {
    object (EffectiveFrequencyLimit)
  },
  "customerReachGroup": string
}
Kolom
campaignDuration

object (CampaignDuration)

Wajib. Durasi kampanye.
cookieFrequencyCapSetting

object (FrequencyCap)

Batas frekuensi cookie yang dipilih untuk diterapkan ke setiap produk yang direncanakan. Hal ini sama dengan batas frekuensi yang ditampilkan di Google Ads saat membuat kampanye. Hal ini menunjukkan frekuensi maksimum iklan dapat ditampilkan kepada pengguna yang sama selama interval waktu yang ditentukan. Jika tidak ditentukan, nilai default 0 (tanpa batas) akan diterapkan.

Kolom ini menggantikan kolom cookieFrequencyCap yang tidak digunakan lagi.
targeting

object (Targeting)

Penargetan yang akan diterapkan ke semua produk yang dipilih dalam kombinasi produk.

Ini adalah penargetan terencana: detail pelaksanaan dapat bervariasi berdasarkan produk iklan, hubungi pakar penerapan.

Lihat metrik tertentu untuk mengetahui detail tentang pengaruh penargetan terhadap mereka.
plannedProducts[]

object (PlannedProduct)

Wajib. Produk yang akan diperkirakan. Jumlah maksimum produk terencana yang diizinkan adalah 15.
forecastMetricOptions

object (ForecastMetricOptions)

Mengontrol metrik perkiraan yang ditampilkan dalam respons.
currencyCode

string

Kode mata uang. Kode mata uang ISO 4217 tiga karakter.
cookieFrequencyCap

integer

Batas frekuensi cookie yang dipilih untuk diterapkan ke setiap produk yang direncanakan. Hal ini sama dengan batas frekuensi yang ditampilkan di Google Ads saat membuat kampanye. Hal ini menunjukkan frekuensi maksimum iklan dapat ditampilkan kepada pengguna yang sama. Jika tidak ditentukan, tidak ada batas yang diterapkan.

Kolom ini tidak digunakan lagi di v4 dan pada akhirnya akan dihapus. Sebagai gantinya, gunakan cookieFrequencyCapSetting.
minEffectiveFrequency

integer

Frekuensi efektif minimum yang dipilih (berapa kali seseorang mendapatkan iklan) untuk metrik jangkauan yang dilaporkan [1-10]. Hal ini tidak akan memengaruhi penargetan, tetapi hanya pelaporan. Jika tidak ditentukan, nilai default 1 akan diterapkan.

Kolom ini tidak dapat digabungkan dengan kolom efektifFrequencyLimit.
effectiveFrequencyLimit

object (EffectiveFrequencyLimit)

Nilai frekuensi efektif minimum tertinggi (frekuensi orang yang terpapar iklan) [1-10] untuk disertakan dalam Forecast.effective_frequency_breakdowns. Jika tidak ditentukan, Forecast.effective_frequency_breakdowns tidak akan diberikan.

Nilai frekuensi efektif yang diberikan di sini juga akan digunakan sebagai frekuensi efektif minimum untuk metrik jangkauan yang dilaporkan.

Kolom ini tidak dapat digabungkan dengan kolom minEffectiveFrequency.
customerReachGroup

string

Nama pelanggan yang direncanakan. Nilai ini ditentukan oleh pengguna.

Isi respons

Pesan respons yang berisi kurva jangkauan yang dihasilkan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (OnTargetAudienceMetrics)

Referensi tentang target audiens untuk kurva ini.
reachCurve

object (ReachCurve)

Kurva jangkauan yang dihasilkan untuk kombinasi produk yang direncanakan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/adwords

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

CampaignDuration

Durasi kampanye yang direncanakan.

Representasi JSON 
{
  "dateRange": {
    object (DateRange)
  },
  "durationInDays": integer
}
Kolom
dateRange

object (DateRange)

Rentang tanggal kampanye. Tanggal dalam format yyyy-mm-dd dan inklusif. Tanggal akhir harus < 1 tahun ke depan dan rentang tanggal harus <= 92 hari.

Kolom ini tidak dapat digabungkan dengan kolom durationInDays.
durationInDays

integer

Nilai durasi dalam hari.

Bidang ini tidak dapat digabungkan dengan bidang dateRange.

FrequencyCap

Aturan yang menetapkan frekuensi maksimum iklan dapat ditampilkan kepada pengguna selama jangka waktu tertentu.

Representasi JSON 
{
  "impressions": integer,
  "timeUnit": enum (FrequencyCapTimeUnit)
}
Kolom
impressions

integer

Wajib. Jumlah tayangan, inklusif.
timeUnit

enum (FrequencyCapTimeUnit)

Wajib. Jenis satuan waktu.

EffectiveFrequencyLimit

Batas frekuensi efektif.

Representasi JSON 
{
  "effectiveFrequencyBreakdownLimit": integer
}
Kolom
effectiveFrequencyBreakdownLimit

integer

Nilai frekuensi efektif tertinggi yang akan disertakan dalam Forecast.effective_frequency_breakdowns. Bidang ini mendukung frekuensi 1-10, inklusif.

Penargetan

Penargetan yang metrik traffic-nya akan dilaporkan.

Representasi JSON 
{
  "plannableLocationIds": [
    string
  ],
  "ageRange": enum (ReachPlanAgeRange),
  "genders": [
    {
      object (GenderInfo)
    }
  ],
  "devices": [
    {
      object (DeviceInfo)
    }
  ],
  "network": enum (ReachPlanNetwork),
  "audienceTargeting": {
    object (AudienceTargeting)
  },
  "plannableLocationId": string
}
Kolom
plannableLocationIds[]

string

Daftar ID lokasi yang dapat direncanakan untuk ditargetkan dengan perkiraan ini.

Jika lebih dari satu ID diberikan, semua ID harus memiliki parentCountryId yang sama. Perencanaan untuk lebih dari parent_county tidak didukung. ID lokasi yang dapat direncanakan dan parentCountryId-nya dapat diperoleh dari ReachPlanService.ListPlannableLocations.

Permintaan harus menetapkan kolom ini atau plannableLocationId.
ageRange

enum (ReachPlanAgeRange)

Rentang usia yang ditargetkan. Nilai yang tidak ditetapkan setara dengan menargetkan semua usia.
genders[]

object (GenderInfo)

Gender yang ditargetkan. Nilai yang tidak ditetapkan setara dengan menargetkan MALE dan FEMALE.
devices[]

object (DeviceInfo)

Perangkat yang ditargetkan. Jika tidak ditentukan, akan menargetkan semua perangkat yang berlaku. Perangkat yang berlaku bervariasi menurut produk dan wilayah dan dapat diperoleh dari ReachPlanService.ListPlannableProducts.
network

enum (ReachPlanNetwork)

Jaringan yang dapat ditargetkan untuk produk iklan. Jika tidak ditentukan, semua jaringan yang berlaku akan ditargetkan. Jaringan yang berlaku bervariasi menurut produk dan wilayah dan dapat diperoleh dari ReachPlanService.ListPlannableProducts.
audienceTargeting

object (AudienceTargeting)

Target audiens. Jika tidak ditentukan, berarti tidak menargetkan audiens tertentu.
plannableLocationId

string

ID lokasi yang dipilih. ID lokasi yang dapat direncanakan dapat diperoleh dari ReachPlanService.ListPlannableLocations.

Permintaan harus menetapkan kolom ini atau plannableLocationIds.

Kolom ini tidak digunakan lagi mulai V12 dan akan dihapus dalam rilis mendatang. Sebagai gantinya, gunakan plannableLocationIds.

AudienceTargeting

Penargetan audiens untuk perkiraan jangkauan.

Representasi JSON 
{
  "userInterest": [
    {
      object (UserInterestInfo)
    }
  ]
}
Kolom
userInterest[]

object (UserInterestInfo)

Daftar audiens berdasarkan minat pengguna yang akan ditargetkan.

PlannedProduct

Produk yang sedang direncanakan untuk jangkauan.

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

object (AdvancedProductTargeting)

Setelan penargetan untuk produk yang dipilih. Untuk mencantumkan penargetan yang tersedia untuk setiap produk, gunakan ReachPlanService.ListPlannableProducts.
plannableProductCode

string

Wajib. Produk yang dipilih untuk perencanaan. Kode yang terkait dengan produk iklan (misalnya: TrueView, Bumper). Untuk mencantumkan kode produk yang dapat direncanakan, gunakan ReachPlanService.ListPlannableProducts.
budgetMicros

string (int64 format)

Wajib. Alokasi anggaran maksimum dalam mikrodetik untuk produk yang dipilih. Nilai ditentukan dalam currencyCode perencanaan yang dipilih. Misalnya: 1.000.000$ = 1.000.000.000.000 mikro.

AdvancedProductTargeting

Setelan penargetan lanjutan untuk produk.

Representasi JSON 
{

  // Union field advanced_targeting can be only one of the following:
  "youtubeSelectSettings": {
    object (YouTubeSelectSettings)
  }
  // End of list of possible types for union field advanced_targeting.
}
Kolom
Kolom union advanced_targeting. Opsi penargetan untuk produk ini. advanced_targeting hanya ada berupa salah satu diantara berikut:
youtubeSelectSettings

object (YouTubeSelectSettings)

Setelan untuk penargetan YouTube Select.

YouTubeSelectSettings

Setelan permintaan untuk Grup Channel YouTube Select

Representasi JSON 
{
  "lineupId": string
}
Kolom
lineupId

string (int64 format)

Grup Channel untuk Penargetan YouTube Select.

ForecastMetricOptions

Mengontrol metrik perkiraan yang akan ditampilkan.

Representasi JSON 
{
  "includeCoview": boolean
}
Kolom
includeCoview

boolean

Menunjukkan apakah akan menyertakan metrik co-view dalam perkiraan respons.

OnTargetAudienceMetrics

Metrik audiens untuk produk yang direncanakan. Metrik ini mempertimbangkan dimensi penargetan berikut:

  • Lokasi
  • PlannableAgeRange
  • Gender
  • PenargetanAudiens (hanya untuk youtubeAudienceSize)
Representasi JSON 
{
  "youtubeAudienceSize": string,
  "censusAudienceSize": string
}
Kolom
youtubeAudienceSize

string (int64 format)

Referensi ukuran audiens yang cocok dengan penargetan yang dipertimbangkan untuk YouTube.
censusAudienceSize

string (int64 format)

Ukuran audiens referensi yang cocok dengan penargetan yang dipertimbangkan untuk Sensus.

ReachCurve

Kurva jangkauan untuk produk yang direncanakan.

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

object (ReachForecast)

Semua titik pada kurva jangkauan.

ReachForecast

Titik pada kurva jangkauan.

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

string (int64 format)

Biaya dalam mikro.
forecast

object (Forecast)

Perkiraan metrik traffic untuk titik ini.
plannedProductReachForecasts[]

object (PlannedProductReachForecast)

Perkiraan alokasi dan metrik traffic untuk setiap produk yang direncanakan pada titik ini di kurva jangkauan.

Perkiraan

Perkiraan metrik traffic untuk produk dan penargetan yang direncanakan.

Representasi JSON 
{
  "effectiveFrequencyBreakdowns": [
    {
      object (EffectiveFrequencyBreakdown)
    }
  ],
  "onTargetReach": string,
  "totalReach": string,
  "onTargetImpressions": string,
  "totalImpressions": string,
  "viewableImpressions": string,
  "onTargetCoviewReach": string,
  "totalCoviewReach": string,
  "onTargetCoviewImpressions": string,
  "totalCoviewImpressions": string
}
Kolom
effectiveFrequencyBreakdowns[]

object (EffectiveFrequencyBreakdown)

Daftar perkiraan frekuensi yang efektif. Daftar ini diurutkan mulai dari angka 1+ dan diakhiri dengan nilai yang ditetapkan dalam GenerateReachForecastRequest.effective_frequency_limit. Jika tidak ada effectiveFrequencyLimit yang ditetapkan, daftar ini akan kosong.
onTargetReach

string (int64 format)

Jumlah orang unik yang mencapai setidaknya waktu GenerateReachForecastRequest.min_effective_frequency atau GenerateReachForecastRequest.effective_frequency_limit kali yang sama persis dengan Penargetan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai onTargetReach akan dibulatkan ke 0.
totalReach

string (int64 format)

Jumlah total orang unik yang mencapai setidaknya waktu GenerateReachForecastRequest.min_effective_frequency atau GenerateReachForecastRequest.effective_frequency_limit kali. Ini mencakup orang-orang yang mungkin berada di luar Penargetan yang ditetapkan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai totalReach akan dibulatkan ke 0.
onTargetImpressions

string (int64 format)

Jumlah tayangan iklan yang sama persis dengan Penargetan.
totalImpressions

string (int64 format)

Total jumlah tayangan iklan. Hal ini mencakup tayangan yang mungkin berada di luar Penargetan yang ditentukan, karena informasi tentang pengguna yang login tidak memadai.
viewableImpressions

string (int64 format)

Frekuensi tayangan iklan dianggap terlihat. Lihat https://support.google.com/google-ads/answer/7029393 untuk informasi lebih lanjut tentang apa yang membuat iklan terlihat dan bagaimana visibilitas diukur.
onTargetCoviewReach

string (int64 format)

Jumlah orang unik yang dijangkau yang sama persis dengan Penargetan termasuk co-viewer.
totalCoviewReach

string (int64 format)

Jumlah orang unik yang dijangkau termasuk co-viewer. Ini mencakup orang-orang yang mungkin berada di luar Penargetan yang ditetapkan.
onTargetCoviewImpressions

string (int64 format)

Jumlah tayangan iklan yang sama persis dengan Penargetan termasuk co-viewer.
totalCoviewImpressions

string (int64 format)

Total jumlah tayangan iklan termasuk co-viewer. Hal ini mencakup tayangan yang mungkin berada di luar Penargetan yang ditentukan, karena informasi tentang pengguna yang login tidak memadai.

EffectiveFrequencyBreakdown

Perincian jumlah orang unik yang dijangkau pada frekuensi efektif tertentu.

Representasi JSON 
{
  "effectiveFrequency": integer,
  "onTargetReach": string,
  "totalReach": string,
  "effectiveCoviewReach": string,
  "onTargetEffectiveCoviewReach": string
}
Kolom
effectiveFrequency

integer

Frekuensi efektif [1-10].
onTargetReach

string (int64 format)

Jumlah orang unik yang dijangkau setidaknya waktu efektifFrekuensi yang sama persis dengan Penargetan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai onTargetReach akan dibulatkan ke 0.
totalReach

string (int64 format)

Total jumlah orang unik yang dicapai setidaknya efektifFrequency kali. Ini mencakup orang-orang yang mungkin berada di luar Penargetan yang ditetapkan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai totalReach akan dibulatkan ke 0.
effectiveCoviewReach

string (int64 format)

Jumlah pengguna (termasuk pengguna yang melakukan co-viewing) yang dijangkau untuk nilai efektifFrequency terkait.
onTargetEffectiveCoviewReach

string (int64 format)

Jumlah pengguna (termasuk pengguna co-viewing) yang dijangkau untuk nilai efektifFrequency terkait dalam demografi rencana yang ditentukan.

PlannedProductReachForecast

Perkiraan alokasi dan metrik traffic untuk produk tertentu pada satu titik di kurva jangkauan.

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

string

Produk yang dipilih untuk perencanaan. Kode produk yang ditampilkan berada dalam kumpulan kode yang ditampilkan oleh ListPlannableProducts saat menggunakan ID lokasi yang sama.
costMicros

string (int64 format)

Biaya dalam mikro. Ini mungkin berbeda dari alokasi input produk jika satu atau beberapa produk yang direncanakan tidak dapat memenuhi anggaran karena inventaris yang terbatas.
plannedProductForecast

object (PlannedProductForecast)

Perkiraan metrik traffic untuk produk ini.

PlannedProductForecast

Perkiraan metrik traffic untuk produk yang direncanakan.

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

string (int64 format)

Jumlah orang unik yang dijangkau yang sama persis dengan Penargetan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai onTargetReach akan dibulatkan ke 0.
totalReach

string (int64 format)

Jumlah orang unik dijangkau. Ini mencakup orang-orang yang mungkin berada di luar Penargetan yang ditetapkan.

Perhatikan bahwa jumlah minimum orang unik harus dijangkau agar data dapat dilaporkan. Jika jumlah minimum tidak terpenuhi, nilai totalReach akan dibulatkan ke 0.
onTargetImpressions

string (int64 format)

Jumlah tayangan iklan yang sama persis dengan Penargetan.
totalImpressions

string (int64 format)

Total jumlah tayangan iklan. Hal ini mencakup tayangan yang mungkin berada di luar Penargetan yang ditentukan, karena informasi tentang pengguna yang login tidak memadai.
viewableImpressions

string (int64 format)

Frekuensi tayangan iklan dianggap terlihat. Lihat https://support.google.com/google-ads/answer/7029393 untuk informasi lebih lanjut tentang apa yang membuat iklan terlihat dan bagaimana visibilitas diukur.
onTargetCoviewReach

string (int64 format)

Jumlah orang unik yang dijangkau yang sama persis dengan Penargetan termasuk co-viewer.
totalCoviewReach

string (int64 format)

Jumlah orang unik yang dijangkau termasuk co-viewer. Ini mencakup orang-orang yang mungkin berada di luar Penargetan yang ditetapkan.
onTargetCoviewImpressions

string (int64 format)

Jumlah tayangan iklan yang sama persis dengan Penargetan termasuk co-viewer.
totalCoviewImpressions

string (int64 format)

Total jumlah tayangan iklan termasuk co-viewer. Hal ini mencakup tayangan yang mungkin berada di luar Penargetan yang ditentukan, karena informasi tentang pengguna yang login tidak memadai.