- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อหาคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- การกำหนดเป้าหมาย
- CampaignDuration
- PlannedProduct
- AdvancedProductTargeting
- SurfaceTargetingSettings
- YouTubeSelectSettings
- OnTargetAudienceMetrics
- ReachCurve
- ReachForecast
- PlannedProductReachForecast
- PlannedProductForecast
- ลองใช้งาน
สร้างการคาดการณ์การเข้าถึงสำหรับผู้ลงโฆษณาและการกำหนดเป้าหมายที่กำหนด
คำขอ HTTP
POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:generateReachForecast
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ | |
|---|---|
advertiserId |
ต้องระบุ รหัสของผู้ลงโฆษณาที่จะเรียกใช้แคมเปญที่วางแผนไว้ |
เนื้อความของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{ "targeting": { object ( |
| ช่อง | |
|---|---|
targeting |
ต้องระบุ พารามิเตอร์การกำหนดเป้าหมายของแคมเปญที่วางแผนไว้ |
campaignDuration |
ต้องระบุ ระยะเวลาของแคมเปญที่วางแผนไว้ |
currencyCode |
ต้องระบุ รหัสสกุลเงินของแพ็กเกจในรูปแบบ ISO 4217 |
plannedProducts[] |
ต้องระบุ รายการโฆษณาที่จะรวมในการคาดการณ์ |
minEffectiveFrequency |
ไม่บังคับ ความถี่ที่มีประสิทธิภาพขั้นต่ำสำหรับเมตริกการเข้าถึงที่รายงาน นี่คือจํานวนครั้งที่น้อยที่สุดที่ลูกค้าต้องเห็นโฆษณาเพื่อให้ถือว่ามีประสิทธิภาพ การตั้งค่านี้ส่งผลต่อการรายงานเท่านั้น ต้องอยู่ระหว่าง 1-10 เท่านั้น หากไม่ได้ระบุไว้ ระบบจะใช้ค่าเริ่มต้นเป็น 1 |
เนื้อหาการตอบกลับ
ข้อความตอบกลับสำหรับ ReachForecastService.GenerateReachForecast
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{ "onTargetAudienceMetrics": { object ( |
| ช่อง | |
|---|---|
onTargetAudienceMetrics |
ขนาดกลุ่มเป้าหมายโดยประมาณสำหรับภูมิศาสตร์ที่กำหนดเป้าหมาย |
reachCurve |
เส้นโค้งการคาดการณ์ที่สร้างขึ้น |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/display-video
ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview
การกำหนดเป้าหมาย
การตั้งค่าการกำหนดเป้าหมายสำหรับแคมเปญที่วางแผนไว้
| การแสดง JSON |
|---|
{ "plannableLocationIds": [ string ], "ageRange": enum ( |
| ช่อง | |
|---|---|
plannableLocationIds[] |
ต้องระบุ รหัสของสถานที่ที่วางแผนได้เพื่อกำหนดเป้าหมาย คุณเรียกข้อมูลสถานที่ที่วางแผนได้โดยใช้วิธี |
ageRange |
ไม่บังคับ ช่วงอายุที่จะกำหนดเป้าหมาย |
genders[] |
ไม่บังคับ ตัวเลือกเพศที่จะกำหนดเป้าหมาย |
devices[] |
ไม่บังคับ อุปกรณ์ที่จะกำหนดเป้าหมาย |
CampaignDuration
ระยะเวลาของแผนการเข้าถึง
| การแสดง JSON |
|---|
{ // Union field |
| ช่อง | |
|---|---|
ฟิลด์ Union duration เลือกระยะเวลาแคมเปญ duration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
durationDays |
ต้องระบุ จำนวนวันที่แผนครอบคลุม |
dateRange |
ต้องระบุ ช่วงวันที่ที่แผนครอบคลุม |
PlannedProduct
การกำหนดค่าสำหรับผลิตภัณฑ์ที่เฉพาะเจาะจงในแพ็กเกจ
| การแสดง JSON |
|---|
{
"plannableProductCode": string,
"budgetMicros": string,
"advancedProductTargeting": {
object ( |
| ช่อง | |
|---|---|
plannableProductCode |
ต้องระบุ รหัสของผลิตภัณฑ์ เช่น "VIDEO_REACH_CAMPAIGN" |
budgetMicros |
ต้องระบุ งบประมาณสำหรับผลิตภัณฑ์นี้ในหน่วยไมโคร |
advancedProductTargeting |
ไม่บังคับ การลบล้างการกำหนดเป้าหมายระดับรายการโฆษณา (ไม่บังคับ) |
AdvancedProductTargeting
การลบล้างการกำหนดเป้าหมายเฉพาะผลิตภัณฑ์
| การแสดง JSON |
|---|
{ "surfaceTargetingSettings": { object ( |
| ฟิลด์ | |
|---|---|
surfaceTargetingSettings |
ไม่บังคับ พื้นผิวที่วางแผนได้เพื่อกำหนดเป้าหมาย |
targetFrequency |
ไม่บังคับ จำนวนครั้งโดยเฉลี่ยที่โฆษณาจะแสดงต่อผู้ใช้คนเดียวกันในช่วงระยะเวลาหนึ่ง |
frequencyCap |
ไม่บังคับ ความถี่สูงสุดสำหรับผลิตภัณฑ์ที่เฉพาะเจาะจง |
ageRange |
ไม่บังคับ ช่วงอายุที่จะกำหนดเป้าหมาย |
genders[] |
ไม่บังคับ ตัวเลือกเพศที่จะกำหนดเป้าหมาย |
devices[] |
ไม่บังคับ อุปกรณ์ที่จะกำหนดเป้าหมาย |
userInterestIds[] |
ไม่บังคับ รหัสความสนใจของผู้ใช้ที่จะกำหนดเป้าหมาย คุณเรียกความสนใจของผู้ใช้ที่วางแผนได้โดยใช้วิธี |
userListIds[] |
ไม่บังคับ รหัสรายชื่อผู้ใช้ที่จะกำหนดเป้าหมาย คุณเรียกข้อมูลรายชื่อผู้ใช้ที่วางแผนได้โดยใช้เมธอด |
youtubeSelectSettings |
ไม่บังคับ การตั้งค่า YouTube Select |
dateRange |
ไม่บังคับ ช่วงวันที่ที่จะกำหนดเป้าหมาย |
plannableLocationIds[] |
ไม่บังคับ รหัสสถานที่ตั้งที่วางแผนได้เพื่อกำหนดเป้าหมาย |
network |
ไม่บังคับ เครือข่ายที่จะกำหนดเป้าหมาย |
SurfaceTargetingSettings
การเลือกการกำหนดเป้าหมายบนแพลตฟอร์ม
| การแสดง JSON |
|---|
{
"surfaces": [
enum ( |
| ฟิลด์ | |
|---|---|
surfaces[] |
ไม่บังคับ แพลตฟอร์มที่จะกำหนดเป้าหมาย |
YouTubeSelectSettings
การตั้งค่าสำหรับรายการช่อง YouTube Select
| การแสดง JSON |
|---|
{ "lineupId": string } |
| ฟิลด์ | |
|---|---|
lineupId |
ไม่บังคับ รหัสของรายการช่อง YouTube Select |
OnTargetAudienceMetrics
ขนาดกลุ่มเป้าหมายโดยประมาณสำหรับภูมิศาสตร์เป้าหมาย
| การแสดง JSON |
|---|
{ "youtubeAudienceSize": string, "censusAudienceSize": string } |
| ช่อง | |
|---|---|
youtubeAudienceSize |
ขนาดโดยประมาณของกลุ่มเป้าหมาย YouTube |
censusAudienceSize |
ขนาดของกลุ่มเป้าหมายตามข้อมูลสำมะโนประชากรของภูมิศาสตร์เป้าหมาย |
ReachCurve
เส้นโค้งการเข้าถึงที่สร้างขึ้น
| การแสดง JSON |
|---|
{
"reachForecasts": [
{
object ( |
| ช่อง | |
|---|---|
reachForecasts[] |
จุดต่างๆ ตามเส้นโค้งที่จัดเรียงตามต้นทุน |
ReachForecast
จุดเดียวในเส้นโค้งการเข้าถึง
| การแสดง JSON |
|---|
{ "costMicros": string, "plannedProductReachForecasts": [ { object ( |
| ช่อง | |
|---|---|
costMicros |
ต้นทุนทั้งหมดสำหรับจุดนี้ในหน่วยไมโคร |
plannedProductReachForecasts[] |
รายละเอียดสำหรับผลิตภัณฑ์แต่ละรายการที่จุดต้นทุนนี้ |
forecast |
การคาดการณ์รวมสำหรับทั้งแผน |
PlannedProductReachForecast
การคาดการณ์ประสิทธิภาพสำหรับผลิตภัณฑ์ที่เฉพาะเจาะจง
| การแสดง JSON |
|---|
{
"costMicros": string,
"plannableProductCode": string,
"plannedProductForecast": {
object ( |
| ช่อง | |
|---|---|
costMicros |
ต้นทุนในหน่วยไมโครสำหรับผลิตภัณฑ์นี้ |
plannableProductCode |
รหัสของผลิตภัณฑ์ |
plannedProductForecast |
เมตริกประสิทธิภาพของผลิตภัณฑ์ |
PlannedProductForecast
เมตริกประสิทธิภาพสำหรับจุดคาดการณ์
| การแสดง JSON |
|---|
{ "onTargetReach": string, "onTargetImpressions": string, "trueviewViews": string, "totalReach": string, "totalImpressions": string, "viewableImpressions": string, "onTargetCoviewReach": string, "totalCoviewReach": string, "onTargetCoviewImpressions": string, "totalCoviewImpressions": string } |
| ช่อง | |
|---|---|
onTargetReach |
จํานวนผู้ใช้ที่ไม่ซ้ำกันที่เข้าถึงซึ่งตรงกับคําจํากัดความของกลุ่มเป้าหมาย |
onTargetImpressions |
จำนวนการแสดงผลตามเป้าหมาย |
trueviewViews |
จำนวนยอดดู TrueView |
totalReach |
จำนวนบุคคลที่ไม่ซ้ำกันทั้งหมดที่เข้าถึง |
totalImpressions |
จำนวนการแสดงผลทั้งหมด |
viewableImpressions |
จำนวนการแสดงผลที่ได้แสดง |
onTargetCoviewReach |
จำนวนผู้ที่ไม่ซ้ำที่มีการเข้าถึงซึ่งตรงกับคำจำกัดความของกลุ่มเป้าหมาย รวมถึงผู้ชมที่ดูร่วมกัน |
totalCoviewReach |
จำนวนรวมของผู้ที่ไม่ซ้ำกันที่มีการเข้าถึง รวมถึงผู้ชมที่ดูร่วมกัน |
onTargetCoviewImpressions |
จำนวนการแสดงผลตามเป้าหมายรวมถึงผู้ชมที่ดูร่วมกัน |
totalCoviewImpressions |
จำนวนการแสดงผลทั้งหมดรวมถึงผู้ที่ดูร่วมกัน |