REST Resource: advertisers.insertionOrders

ทรัพยากร: InsertionOrder

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

การแสดง 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),
  "optimizationObjective": enum (OptimizationObjective)
}
ช่อง
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)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
partnerCosts[]

object (PartnerCost)

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

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

object (Pacing)

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

pacingType PACING_TYPE_ASAP ไม่สามารถใช้งานร่วมกับ pacingPeriod PACING_PERIOD_FLIGHT
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

ซึ่งจะแสดงเป็น "เป้าหมาย" ในอินเทอร์เฟซ Display & Video 360
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

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

enum (ReservationType)

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

enum (OptimizationObjective)

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

InsertionOrderType

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

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

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทใบสั่งซื้อการใส่โฆษณาหรือไม่รู้จักประเภทใบสั่งซื้อการใส่โฆษณา
RTB การเสนอราคาแบบเรียลไทม์
OVER_THE_TOP Over-the-top
OUT_OF_HOME สื่อนอกบ้าน

KPI

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
ช่อง
kpiType

enum (KpiType)

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

string (int64 format)

ไม่บังคับ รหัสอัลกอริทึมราคาเสนอที่กำหนดเองที่เชื่อมโยงกับ KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST ระบบจะไม่สนใจช่องนี้หากไม่ได้เลือก KPI ที่เหมาะสม
ต้องระบุ ค่าของ KPI ช่องที่เกี่ยวข้องจะสอดคล้องกับ kpi_type ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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_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 (ต้นทุนต่อการแสดงผลที่มองเห็นได้พันครั้ง)
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 อนุญาตให้ระบบปรับราคาเสนอและเปลี่ยนงบประมาณไปยังรายการโฆษณาที่เป็นเจ้าของโดยอัตโนมัติเพื่อเพิ่มประสิทธิภาพที่กำหนดโดย bidStrategy

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 หรือหลังจากนั้น และทั้ง 2 วันต้องก่อนปี 2037
campaignBudgetId

string (int64 format)

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

OptimizationObjective

ประเภทที่เป็นไปได้ของวัตถุประสงค์การเพิ่มประสิทธิภาพ

Enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED ไม่ได้ระบุค่าประเภทหรือไม่รู้จักค่าประเภทในเวอร์ชันนี้
CONVERSION จัดลำดับความสำคัญของการแสดงผลที่เพิ่มยอดขายและ Conversion
CLICK จัดลําดับความสําคัญของการแสดงผลที่เพิ่มการเข้าชมเว็บไซต์ แอป และ App Store
BRAND_AWARENESS จัดลำดับความสำคัญของการแสดงผลที่มีคุณภาพเฉพาะ
CUSTOM วัตถุประสงค์จะกําหนดโดยอัลกอริทึมการเสนอราคาที่กําหนดเองที่กําหนดไว้
NO_OBJECTIVE ไม่ได้กําหนดวัตถุประสงค์ คุณสามารถใช้ KPI หรือกลยุทธ์การเสนอราคาใดก็ได้

เมธอด

create

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

delete

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

get

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

list

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

patch

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