REST Resource: advertisers.insertionOrders

แหล่งข้อมูล: InsertOrder

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

การแสดง 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)

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

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

enum (ReservationType)

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

enum (OptimizationObjective)

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

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

InsertionOrderType

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

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

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED ไม่ได้ระบุหรือไม่รู้จักประเภทใบสั่งซื้อการใส่โฆษณา
RTB การเสนอราคาแบบเรียลไทม์
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_TYPE_CPM KPI คือ CPM (ต้นทุนต่อการแสดงผล 1,000 ครั้ง)
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 อนุญาตให้ระบบปรับราคาเสนอและย้ายงบประมาณไปยังบรรทัดรายการที่เป็นเจ้าของโดยอัตโนมัติเพื่อเพิ่มประสิทธิภาพที่ระบุโดย 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 ของงบประมาณแคมเปญที่มีกลุ่มงบประมาณใบสั่งซื้อการใส่โฆษณานี้

OptimizationObjective

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

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

เมธอด

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

 อัปเดตคําสั่งซื้อการแทรกที่มีอยู่