Method: advertisers.reachForecast.generateReachForecast

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

คำขอ HTTP

POST https://displayvideo.googleapis.com/v4/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
{

  // 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.
}
ช่อง
ฟิลด์ Union duration เลือกระยะเวลาแคมเปญ duration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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)

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