Method: advertisers.reachForecast.generateReachForecast

สร้างการคาดการณ์การเข้าถึงสําหรับผู้ลงโฆษณาและการกําหนดค่าการกําหนดเป้าหมายที่ระบุ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส 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

ไม่บังคับ ความถี่ต่ำสุดที่มีประสิทธิภาพสำหรับเมตริกการเข้าถึงที่รายงาน ซึ่งเป็นจำนวนครั้งที่น้อยที่สุดที่ลูกค้าต้องเห็นโฆษณาเพื่อให้ถือว่ามีประสิทธิภาพ การตั้งค่านี้ส่งผลต่อการรายงานเท่านั้น

โดยต้องอยู่ระหว่าง 1-10 เท่านั้น หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น 1

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ 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.
}
ช่อง
เลือกระยะเวลาแคมเปญ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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)

จำนวนการแสดงผลทั้งหมดรวมถึงผู้ดูร่วมกัน