- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ProductMetadata
- PlannableTargeting
- SurfaceTargetingCombinations
- SurfaceTargetingCombination
- YouTubeSelectLineUp
- PlannableProductCoreAttributes
- PlannableBuyingMethod
- PlannableCostModel
- ลองใช้งาน
ดึงข้อมูลรายการผลิตภัณฑ์ที่วางแผนสำหรับสถานที่ตั้งได้
คำขอ HTTP
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableProducts
URL ใช้ไวยากรณ์การแปลงรหัส gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ | |
|---|---|
advertiserId |
ต้องระบุ รหัสของผู้ลงโฆษณาที่จะแสดงผลิตภัณฑ์ที่วางแผนได้ |
พารามิเตอร์การค้นหา
| พารามิเตอร์ | |
|---|---|
plannableLocationId |
ต้องระบุ รหัสของสถานที่ที่วางแผนได้ |
เนื้อความของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบกลับสำหรับ reachForecast.retrievePlannableProducts
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{
"productMetadata": [
{
object ( |
| ช่อง | |
|---|---|
productMetadata[] |
เอาต์พุตเท่านั้น รายการข้อมูลเมตาของผลิตภัณฑ์ที่แสดงความเป็นไปได้ในการกำหนดเป้าหมาย |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/display-video
ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview
ProductMetadata
ข้อมูลเมตาสำหรับผลิตภัณฑ์ที่วางแผนได้
| การแสดง JSON |
|---|
{ "plannableProductDescription": string, "plannableProductCode": string, "plannableTargeting": { object ( |
| ช่อง | |
|---|---|
plannableProductDescription |
เอาต์พุตเท่านั้น คำอธิบายแบบข้อความธรรมดาของผลิตภัณฑ์โฆษณา |
plannableProductCode |
เอาต์พุตเท่านั้น รหัสผลิตภัณฑ์ที่วางแผนได้ (เช่น "YOUTUBE_REACH_MIX") |
plannableTargeting |
เอาต์พุตเท่านั้น ความสามารถในการกำหนดเป้าหมายที่พร้อมใช้งานสำหรับผลิตภัณฑ์นี้ |
displayName |
เอาต์พุตเท่านั้น ชื่อที่เชื่อมโยงกับผลิตภัณฑ์โฆษณา เช่น "แคมเปญยอดดูวิดีโอ" |
plannableProductCoreAttributes |
เอาต์พุตเท่านั้น แอตทริบิวต์หลักสำหรับผลิตภัณฑ์นี้ |
PlannableTargeting
ความสามารถในการกำหนดเป้าหมายสำหรับผลิตภัณฑ์หนึ่งๆ
| การแสดง JSON |
|---|
{ "ageRanges": [ enum ( |
| ช่อง | |
|---|---|
ageRanges[] |
เอาต์พุตเท่านั้น ช่วงอายุที่วางแผนได้ที่อนุญาตสำหรับผลิตภัณฑ์ การกำหนดเป้าหมายจริงจะคำนวณโดยการจับคู่ช่วงอายุนี้กับการกำหนดเป้าหมายตามอายุมาตรฐานของ Google |
surfaceTargetingCombinations |
เอาต์พุตเท่านั้น ชุดรวมแพลตฟอร์มที่กำหนดเป้าหมายได้สำหรับผลิตภัณฑ์โฆษณา |
genders[] |
เอาต์พุตเท่านั้น เพศที่กำหนดเป้าหมายได้สำหรับผลิตภัณฑ์โฆษณา |
networks[] |
เอาต์พุตเท่านั้น เครือข่ายที่กำหนดเป้าหมายได้สำหรับผลิตภัณฑ์โฆษณา |
devices[] |
เอาต์พุตเท่านั้น อุปกรณ์ที่กำหนดเป้าหมายได้สำหรับผลิตภัณฑ์โฆษณา |
youtubeSelectLineups[] |
เอาต์พุตเท่านั้น รายการช่อง YouTube Select ที่กำหนดเป้าหมายได้สำหรับผลิตภัณฑ์โฆษณา |
defaultYoutubeSelectLineup |
เอาต์พุตเท่านั้น รายการช่อง YouTube Select เริ่มต้นสำหรับผลิตภัณฑ์นี้ (หากมี) |
SurfaceTargetingCombinations
กฎการกำหนดเป้าหมายแพลตฟอร์ม
| การแสดง JSON |
|---|
{ "availableSurfaceTypes": [ enum ( |
| ช่อง | |
|---|---|
availableSurfaceTypes[] |
เอาต์พุตเท่านั้น ประเภทแพลตฟอร์มที่ใช้ได้ |
validSurfaceCombinations[] |
เอาต์พุตเท่านั้น ชุดค่าผสมที่ถูกต้องของแพลตฟอร์มที่เลือกพร้อมกันได้ |
defaultSurfaceTypes[] |
เอาต์พุตเท่านั้น ประเภทแพลตฟอร์มเริ่มต้นสำหรับผลิตภัณฑ์นี้ |
SurfaceTargetingCombination
ชุดค่าผสมของแพลตฟอร์มที่ถูกต้อง
| การแสดง JSON |
|---|
{
"choices": [
enum ( |
| ช่อง | |
|---|---|
choices[] |
เอาต์พุตเท่านั้น การรวมกันของแพลตฟอร์ม |
YouTubeSelectLineUp
รายการช่อง YouTube Select ที่วางแผนได้สำหรับการกำหนดเป้าหมายผลิตภัณฑ์
| การแสดง JSON |
|---|
{ "lineupId": string, "displayName": string } |
| ช่อง | |
|---|---|
lineupId |
เอาต์พุตเท่านั้น รหัสของรายการช่อง YouTube Select |
displayName |
เอาต์พุตเท่านั้น ชื่อที่แสดงของรายการช่อง YouTube Select |
PlannableProductCoreAttributes
แอตทริบิวต์หลักสำหรับผลิตภัณฑ์ที่วางแผนได้
| การแสดง JSON |
|---|
{ "productCategory": enum ( |
| ช่อง | |
|---|---|
productCategory |
เอาต์พุตเท่านั้น หมวดหมู่สินค้า |
buyingMethod |
เอาต์พุตเท่านั้น วิธีการซื้อ |
costModel |
เอาต์พุตเท่านั้น รูปแบบต้นทุน |
PlannableBuyingMethod
วิธีการซื้อผลิตภัณฑ์ที่วางแผนได้
| Enum | |
|---|---|
PLANNABLE_BUYING_METHOD_UNSPECIFIED |
ไม่ได้ระบุ |
PLANNABLE_BUYING_METHOD_AUCTION |
การประมูล |
PLANNABLE_BUYING_METHOD_RESERVATION |
การจอง |
PlannableCostModel
รูปแบบต้นทุนของผลิตภัณฑ์ที่วางแผนได้
| Enum | |
|---|---|
PLANNABLE_COST_MODEL_UNSPECIFIED |
ไม่ได้ระบุ |
PLANNABLE_COST_MODEL_CPM |
CPM |
PLANNABLE_COST_MODEL_CPV |
CPV |
PLANNABLE_COST_MODEL_CPC |
CPC |
PLANNABLE_COST_MODEL_CPA |
CPA สูงสุด |