REST Resource: advertisers.insertionOrders

แหล่งข้อมูล: ใบสั่งซื้อการใส่โฆษณา

ใบสั่งซื้อการใส่โฆษณารายการเดียว

การแสดง JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของใบสั่งซื้อการใส่โฆษณา
advertiserId

string (int64 format)

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของผู้ลงโฆษณาที่มีใบสั่งซื้อการใส่โฆษณา
campaignId

string (int64 format)

ต้องระบุ เปลี่ยนแปลงไม่ได้ รหัสที่ไม่ซ้ำกันของแคมเปญที่มีใบสั่งซื้อการใส่โฆษณา
insertionOrderId

string (int64 format)

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของใบสั่งซื้อการใส่โฆษณา กำหนดโดยระบบ
displayName

string

ต้องระบุ ชื่อที่แสดงของใบสั่งซื้อการใส่โฆษณา

ต้องเป็นแบบ UTF-8 ที่เข้ารหัสด้วยขนาดสูงสุด 240 ไบต์
insertionOrderType

enum (InsertionOrderType)

ประเภทของใบสั่งซื้อการใส่โฆษณา

หากไม่ได้ระบุช่องนี้ในการสร้าง ค่าเริ่มต้นจะเป็น RTB
entityStatus

enum (EntityStatus)

ต้องระบุ ควบคุมว่าใบสั่งซื้อการใส่โฆษณาจะใช้งบประมาณและเสนอราคาในพื้นที่โฆษณาได้หรือไม่

  • สำหรับเมธอด insertionOrders.create จะอนุญาตเฉพาะ ENTITY_STATUS_DRAFT เท่านั้น หากต้องการเปิดใช้งานใบสั่งซื้อการใส่โฆษณา ให้ใช้เมธอด insertionOrders.patch แล้วอัปเดตสถานะเป็น ENTITY_STATUS_ACTIVE หลังจากสร้าง
  • ใบสั่งซื้อการใส่โฆษณาไม่สามารถเปลี่ยนกลับเป็นสถานะ ENTITY_STATUS_DRAFT จากสถานะอื่นๆ ได้
  • ไม่สามารถตั้งค่าใบสั่งซื้อการใส่โฆษณาเป็น ENTITY_STATUS_ACTIVE ได้ หากแคมเปญหลักไม่ทำงาน
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดตใบสั่งซื้อการใส่โฆษณาครั้งล่าสุด กำหนดโดยระบบ

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
partnerCosts[]

object (PartnerCost)

ค่าใช้จ่ายของพาร์ทเนอร์ที่เชื่อมโยงกับใบสั่งซื้อการใส่โฆษณา

หากไม่มีหรือว่างเปล่าในเมธอด insertionOrders.create ใบสั่งซื้อการใส่โฆษณาที่สร้างขึ้นใหม่จะรับค่าค่าใช้จ่ายของพาร์ทเนอร์จากการตั้งค่าของพาร์ทเนอร์
pacing

object (Pacing)

ต้องระบุ การตั้งค่าความเร็วในการใช้จ่ายงบประมาณของใบสั่งซื้อการใส่โฆษณา
frequencyCap

object (FrequencyCap)

ต้องระบุ การตั้งค่าการกำหนดความถี่สูงสุดของใบสั่งซื้อการใส่โฆษณา
integrationDetails

object (IntegrationDetails)

รายละเอียดการผสานรวมเพิ่มเติมของใบสั่งซื้อการใส่โฆษณา
kpi

object (Kpi)

ต้องระบุ ตัวชี้วัดประสิทธิภาพ (KPI) ของใบสั่งซื้อการใส่โฆษณา

ซึ่งอาจเรียกว่า "เป้าหมาย" ในอินเทอร์เฟซ Display & Video 360
budget

object (InsertionOrderBudget)

ต้องระบุ การตั้งค่าการจัดสรรงบประมาณของใบสั่งซื้อการใส่โฆษณา
bidStrategy

object (BiddingStrategy)

กลยุทธ์การเสนอราคาของใบสั่งซื้อการใส่โฆษณา ระบบจะตั้งค่า fixedBid ไว้โดยค่าเริ่มต้น
reservationType

enum (ReservationType)

เอาต์พุตเท่านั้น ประเภทการจองของใบสั่งซื้อการใส่โฆษณา

InsertionOrderType

ประเภทของใบสั่งซื้อการใส่โฆษณาที่เป็นไปได้

ประเภทของใบสั่งซื้อการใส่โฆษณาจะเป็นตัวกำหนดการตั้งค่าและตัวเลือกที่เกี่ยวข้อง เช่น รูปแบบโฆษณาหรือตัวเลือกการกำหนดเป้าหมาย

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทใบสั่งซื้อการใส่โฆษณาหรือไม่ทราบประเภท
RTB การเสนอราคาแบบเรียลไทม์
OVER_THE_TOP การแพร่ภาพและเสียงผ่านโครงข่ายอินเทอร์เน็ต (Over The Top)

KPI

การตั้งค่าที่ควบคุมตัวชี้วัดประสิทธิภาพหรือ KPI ของใบสั่งซื้อการใส่โฆษณา

การแสดง JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
ช่อง
kpiType

enum (KpiType)

ต้องระบุ ประเภทของ KPI
kpiAlgorithmId

string (int64 format)

ไม่บังคับ รหัสอัลกอริทึมการเสนอราคาที่กำหนดเองที่เชื่อมโยงกับ KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ระบบจะไม่สนใจช่องนี้หากไม่ได้เลือก KPI ที่เหมาะสม
ฟิลด์สหภาพ kpi_value ต้องระบุ ค่าของ KPI ช่องที่เกี่ยวข้องสอดคล้องกับ kpi_type kpi_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
kpiAmountMicros

string (int64 format)

จำนวนเงินเป้าหมายในหน่วยไมโครของสกุลเงินของผู้ลงโฆษณา

ใช้ได้เมื่อ kpiType เป็นหนึ่งในรายการต่อไปนี้

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

เช่น 1500000 คือ 1.5 หน่วยมาตรฐานของสกุลเงิน
kpiPercentageMicros

string (int64 format)

ค่าเปอร์เซ็นต์เป้าหมายในรูปทศนิยมในหน่วยไมโคร

ใช้ได้เมื่อ kpiType เป็นหนึ่งในรายการต่อไปนี้

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

เช่น 70000 แทน 7% (ทศนิยม 0.07)
kpiString

string

สตริง KPI สตริงนี้สามารถเว้นว่างไว้ได้ ต้องเป็น UTF-8 ที่เข้ารหัสโดยมีความยาวไม่เกิน 100 อักขระ

ใช้ได้เมื่อkpiTypeคือKPI_TYPE_OTHER

KpiType

ประเภทตัวชี้วัดประสิทธิภาพ (KPI) ที่เป็นไปได้

Enum
KPI_TYPE_UNSPECIFIED ไม่ได้ระบุประเภท KPI หรือไม่ทราบประเภท KPI ในเวอร์ชันนี้
KPI_TYPE_CPM KPI คือ CPM (ต้นทุนต่อการแสดงผลพันครั้ง)
KPI_TYPE_CPC KPI คือ CPC (ต้นทุนต่อคลิก)
KPI_TYPE_CPA KPI คือ CPA (ต้นทุนต่อหนึ่งการกระทำ)
KPI_TYPE_CTR KPI คือเปอร์เซ็นต์ CTR (อัตราการคลิกผ่าน)
KPI_TYPE_VIEWABILITY KPI คือเปอร์เซ็นต์การมองเห็นโฆษณา
KPI_TYPE_CPIAVC KPI คือ CPIAVC (ต้นทุนต่อการแสดงผลพันครั้งที่ได้ยินเสียงและมองเห็นได้เมื่อวิดีโอจบ)
KPI_TYPE_CPE KPI คือ CPE (ต้นทุนต่อการมีส่วนร่วม)
KPI_TYPE_CPV มีการตั้งค่า KPI เป็น CPV (ต้นทุนต่อการดู)
KPI_TYPE_CLICK_CVR KPI คืออัตรา Conversion การคลิก (Conversion ต่อคลิก)
KPI_TYPE_IMPRESSION_CVR KPI คืออัตรา Conversion การแสดงผล (Conversion ต่อการแสดงผล)
KPI_TYPE_VCPM KPI คือ VCPM (ต้นทุนต่อการแสดงผลที่ได้แสดง 1,000 ครั้ง)
KPI_TYPE_VTR KPI คืออัตราการดูของ YouTube (การดูต่อการแสดงผลของ YouTube)
KPI_TYPE_AUDIO_COMPLETION_RATE KPI คืออัตราการเล่นเสียงจนจบ (การฟังเสียงที่สมบูรณ์ต่อการแสดงผล)
KPI_TYPE_VIDEO_COMPLETION_RATE KPI คืออัตราการเล่นวิดีโอจนจบ (การดูวิดีโอที่สมบูรณ์ต่อการแสดงผล)
KPI_TYPE_CPCL มีการตั้งค่า KPI เป็น CPCL (ต้นทุนต่อการฟังเสียงจนจบ)
KPI_TYPE_CPCV ซึ่งจะกำหนด KPI เป็น CPCV (ต้นทุนต่อการดูวิดีโอจนจบ)
KPI_TYPE_TOS10 ระบบจะกำหนด KPI ไว้ในอัตราเวลาบนหน้าจออย่างน้อย 10 วินาที (เปอร์เซ็นต์ของการแสดงผลที่วัดได้และข้ามไม่ได้ที่อยู่บนหน้าจออย่างน้อย 10 วินาที)
KPI_TYPE_MAXIMIZE_PACING โดยมีการตั้ง KPI เพื่อเพิ่มผลลัพธ์ของแบรนด์ให้สูงสุด ในขณะเดียวกันก็ให้ความสำคัญกับการใช้งบประมาณทั้งหมด
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST มีการตั้งค่า KPI ในค่าของการแสดงผลที่กำหนดเองหารด้วยต้นทุน
KPI_TYPE_OTHER แต่ KPI เป็นค่าอื่น

InsertionOrderBudget

การตั้งค่าที่ควบคุมวิธีจัดสรรงบประมาณใบสั่งซื้อการใส่โฆษณา

การแสดง JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
ช่อง
budgetUnit

enum (BudgetUnit)

ต้องระบุ เปลี่ยนแปลงไม่ได้ หน่วยงบประมาณจะระบุว่างบประมาณตามสกุลเงินหรือตามการแสดงผล
automationType

enum (InsertionOrderAutomationType)

ประเภทของการทำงานอัตโนมัติที่ใช้จัดการราคาเสนอและงบประมาณสำหรับใบสั่งซื้อการใส่โฆษณา

หากไม่ได้ระบุช่องนี้ในการสร้าง ค่าเริ่มต้นจะเป็น INSERTION_ORDER_AUTOMATION_TYPE_NONE
budgetSegments[]

object (InsertionOrderBudgetSegment)

ต้องระบุ รายการกลุ่มงบประมาณ ใช้กลุ่มงบประมาณเพื่อระบุงบประมาณที่เจาะจงสำหรับช่วงเวลาหนึ่งๆ ที่ใบสั่งซื้อการใส่โฆษณาทำงาน

InsertionOrderAutomationType

ตัวเลือกที่เป็นไปได้สำหรับการเสนอราคาและงบประมาณของใบสั่งซื้อการใส่โฆษณาโดยอัตโนมัติ

Enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED ไม่ได้ระบุตัวเลือกระบบอัตโนมัติของใบสั่งซื้อการใส่โฆษณาหรือไม่รู้จักในเวอร์ชันนี้
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET การจัดสรรงบประมาณอัตโนมัติ ให้ระบบเปลี่ยนงบประมาณไปยังรายการโฆษณาที่เป็นเจ้าของโดยอัตโนมัติเพื่อเพิ่มประสิทธิภาพที่กำหนดโดย kpi ไม่มีการทำงานอัตโนมัติในการตั้งค่าการเสนอราคา
INSERTION_ORDER_AUTOMATION_TYPE_NONE ไม่มีการเสนอราคาหรืองบประมาณอัตโนมัติในระดับใบสั่งซื้อการใส่โฆษณา ต้องกําหนดค่าราคาเสนอและงบประมาณด้วยตนเองที่ระดับรายการโฆษณา
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET ให้ระบบปรับราคาเสนอโดยอัตโนมัติและโยกย้ายงบประมาณไปเป็นเจ้าของรายการโฆษณาที่เป็นเจ้าของเพื่อเพิ่มประสิทธิภาพที่ kpi กำหนด

InsertionOrderBudgetSegment

การตั้งค่าที่ควบคุมงบประมาณของกลุ่มงบประมาณกลุ่มเดียว

การแสดง JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
ช่อง
budgetAmountMicros

string (int64 format)

ต้องระบุ จํานวนงบประมาณที่ใบสั่งซื้อการใส่โฆษณาจะใช้สำหรับ dateRange ที่ระบุ จำนวนในหน่วยไมโคร ต้องมากกว่า 0 เช่น 500000000 หมายถึง 500 หน่วยมาตรฐานของสกุลเงิน
description

string

คำอธิบายกลุ่มงบประมาณ ซึ่งสามารถใช้เพื่อป้อนข้อมูลใบสั่งซื้อสําหรับกลุ่มงบประมาณแต่ละกลุ่ม และพิมพ์ข้อมูลดังกล่าวในใบแจ้งหนี้ได้

ต้องเข้ารหัส UTF-8
dateRange

object (DateRange)

ต้องระบุ การตั้งค่าวันที่เริ่มต้นและวันที่สิ้นสุดของกลุ่มงบประมาณ ซึ่งจะได้รับการแก้ไขตามเขตเวลาของผู้ลงโฆษณาหลัก

  • เมื่อสร้างกลุ่มงบประมาณใหม่ ทั้ง startDate และ endDate ต้องเป็นวันที่ในอนาคต
  • กลุ่มงบประมาณที่มีอยู่ซึ่งมี startDate ในอดีตมี endDate ที่เปลี่ยนแปลงได้ แต่มี startDate ที่เปลี่ยนแปลงไม่ได้
  • endDate ต้องเป็น startDate ขึ้นไป ทั้งคู่ก่อนปี 2037
campaignBudgetId

string (int64 format)

budgetId ของงบประมาณแคมเปญที่มีกลุ่มงบประมาณใบสั่งซื้อการใส่โฆษณานี้

วิธีการ

create

 สร้างใบสั่งซื้อการใส่โฆษณาใหม่

delete

 ลบใบสั่งซื้อการใส่โฆษณา

get

 รับใบสั่งซื้อการใส่โฆษณา

list

 แสดงรายการใบสั่งซื้อการใส่โฆษณาในผู้ลงโฆษณา

listAssignedTargetingOptions

 รายการตัวเลือกการกำหนดเป้าหมายที่กำหนดไว้ของใบสั่งซื้อการใส่โฆษณาในประเภทการกำหนดเป้าหมายต่างๆ

patch

 อัปเดตใบสั่งซื้อการใส่โฆษณาที่มีอยู่