REST Resource: advertisers.insertionOrders

{
  "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),
  "optimizationObjective": enum (OptimizationObjective)
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

ต้องเป็น UTF-8 ที่เข้ารหัสขนาดไม่เกิน 240 ไบต์

enum (InsertionOrderType)

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

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

enum (EntityStatus)

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

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

string (Timestamp format)

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

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

object (PartnerCost)

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

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

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (OptimizationObjective)

ไม่บังคับ วัตถุประสงค์การเพิ่มประสิทธิภาพของใบสั่งซื้อการใส่โฆษณา

ช่องนี้ใช้ได้เฉพาะลูกค้าที่อยู่ในรายการที่อนุญาตเท่านั้น หากลูกค้าไม่ได้อยู่ในรายการที่อนุญาต ช่องนี้จะเป็นค่าว่างและพยายามตั้งค่า ระบบจะแสดงข้อผิดพลาด

{
  "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.
}

enum (KpiType)

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

string (int64 format)

ไม่บังคับ รหัสอัลกอริทึมการเสนอราคาที่กำหนดเองที่เชื่อมโยงกับ KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ระบบจะไม่สนใจฟิลด์นี้หากไม่ได้เลือก KPI ที่เหมาะสม

string (int64 format)

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

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

• KPI_TYPE_CPM
• KPI_TYPE_CPC
• KPI_TYPE_CPA
• KPI_TYPE_CPIAVC
• KPI_TYPE_VCPM

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

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)

string

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

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

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

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

enum (InsertionOrderAutomationType)

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

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

object (InsertionOrderBudgetSegment)

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

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string (int64 format)

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

string

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

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

object (DateRange)

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

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

string (int64 format)

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