REST Resource: advertisers.insertionOrders

Tài nguyên: InsertOrder

Một đơn đặt hàng quảng cáo.

Biểu diễn dưới dạng 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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của đơn đặt hàng quảng cáo.
advertiserId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của nhà quảng cáo có đơn đặt hàng quảng cáo.
campaignId

string (int64 format)

Bắt buộc. Bất biến. Mã nhận dạng duy nhất của chiến dịch chứa đơn đặt hàng quảng cáo.
insertionOrderId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của đơn đặt hàng quảng cáo. Do hệ thống chỉ định.
displayName

string

Bắt buộc. Tên hiển thị của đơn đặt hàng quảng cáo.

Phải được mã hoá UTF-8 với kích thước tối đa là 240 byte.
insertionOrderType

enum (InsertionOrderType)

Loại đơn đặt hàng quảng cáo.

Nếu bạn không chỉ định trường này khi tạo, thì giá trị mặc định sẽ là RTB.
entityStatus

enum (EntityStatus)

Bắt buộc. Kiểm soát việc đơn đặt hàng quảng cáo có thể chi tiêu ngân sách và giá thầu cho khoảng không quảng cáo hay không.

  • Đối với phương thức insertionOrders.create, chỉ ENTITY_STATUS_DRAFT được phép. Để kích hoạt đơn đặt hàng quảng cáo, hãy sử dụng phương thức insertionOrders.patch và cập nhật trạng thái thành ENTITY_STATUS_ACTIVE sau khi tạo.
  • Bạn không thể thay đổi đơn đặt hàng quảng cáo về trạng thái ENTITY_STATUS_DRAFT từ bất kỳ trạng thái nào khác.
  • Không thể đặt đơn đặt hàng quảng cáo thành ENTITY_STATUS_ACTIVE nếu chiến dịch gốc của đơn đặt hàng đó không hoạt động.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian khi đơn đặt hàng quảng cáo được cập nhật lần gần đây nhất. Do hệ thống chỉ định.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

Chi phí của đối tác liên quan đến đơn đặt hàng quảng cáo.

Nếu không có hoặc để trống trong phương thức insertionOrders.create, đơn đặt hàng quảng cáo mới tạo sẽ kế thừa chi phí của đối tác từ chế độ cài đặt của đối tác.
pacing

object (Pacing)

Bắt buộc. Chế độ cài đặt tốc độ chi tiêu ngân sách của đơn đặt hàng quảng cáo.
frequencyCap

object (FrequencyCap)

Bắt buộc. Chế độ cài đặt giới hạn tần suất của đơn đặt hàng quảng cáo.
integrationDetails

object (IntegrationDetails)

Thông tin chi tiết bổ sung về hoạt động tích hợp của đơn đặt hàng quảng cáo.
performanceGoal

object (PerformanceGoal)

Bắt buộc. Mục tiêu hiệu suất của đơn đặt hàng quảng cáo.
budget

object (InsertionOrderBudget)

Bắt buộc. Chế độ cài đặt mức phân bổ ngân sách của đơn đặt hàng quảng cáo.
bidStrategy

object (BiddingStrategy)

Chiến lược đặt giá thầu của đơn đặt hàng quảng cáo. Theo mặc định, fixedBid được đặt.
reservationType

enum (ReservationType)

Chỉ có đầu ra. Loại đặt trước của đơn đặt hàng quảng cáo.
billableOutcome

enum (BillableOutcome)

Bất biến. Kết quả có thể tính phí của đơn đặt hàng quảng cáo.

Phương thức mua dựa trên kết quả hiện không còn được dùng nữa. BILLABLE_OUTCOME_PAY_PER_IMPRESSION là giá trị hợp lệ duy nhất.

InsertionOrderType

Các loại Đơn đặt hàng quảng cáo có thể có.

Loại Đơn đặt hàng quảng cáo xác định cài đặt và tùy chọn nào có thể áp dụng, chẳng hạn như định dạng quảng cáo hoặc tùy chọn nhắm mục tiêu.

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED Loại đơn đặt hàng quảng cáo chưa được chỉ định hoặc không xác định.
RTB Đặt giá thầu theo thời gian thực.
OVER_THE_TOP Trực tiếp qua Internet.

InsertionOrderBudget

Chế độ cài đặt kiểm soát cách phân bổ ngân sách đơn đặt hàng quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Trường
budgetUnit

enum (BudgetUnit)

Bắt buộc. Bất biến. Đơn vị ngân sách chỉ định ngân sách dựa trên đơn vị tiền tệ hay dựa trên lượt hiển thị.
automationType

enum (InsertionOrderAutomationType)

Loại tự động hoá được dùng để quản lý giá thầu và ngân sách cho đơn đặt hàng quảng cáo.

Nếu bạn không chỉ định trường này khi tạo, thì giá trị mặc định sẽ là INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Bắt buộc. Danh sách phân đoạn ngân sách. Sử dụng phân đoạn ngân sách để chỉ định ngân sách cụ thể trong một khoảng thời gian nhất định mà đơn đặt hàng quảng cáo đang chạy.

InsertionOrderAutomationType

Các lựa chọn có thể dùng để tự động hoá giá thầu và ngân sách cho đơn đặt hàng quảng cáo.

Enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Tuỳ chọn tự động hoá đơn đặt hàng quảng cáo chưa được chỉ định hoặc không xác định trong phiên bản này.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Tự động phân bổ ngân sách. Cho phép hệ thống tự động chuyển ngân sách sang sở hữu các mục hàng để tối ưu hoá hiệu suất do performanceGoal xác định. Không tự động hoá chế độ cài đặt giá thầu.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Không tự động hoá giá thầu hoặc ngân sách ở cấp đơn đặt hàng quảng cáo. Bạn phải định cấu hình giá thầu và ngân sách theo cách thủ công ở cấp mục hàng.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Cho phép hệ thống tự động điều chỉnh giá thầu và chuyển ngân sách sang sở hữu các mục hàng để tối ưu hoá hiệu suất do performanceGoal xác định.

InsertionOrderBudgetSegment

Chế độ cài đặt kiểm soát ngân sách của một phân đoạn ngân sách.

Biểu diễn dưới dạng JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Trường
budgetAmountMicros

string (int64 format)

Bắt buộc. Số tiền ngân sách mà đơn đặt hàng quảng cáo sẽ chi tiêu cho dateRange đã cho. Số lượng được tính bằng phần triệu. Phải lớn hơn 0. Ví dụ: 500000000 đại diện cho 500 đơn vị tiền tệ tiêu chuẩn.
description

string

Mô tả phân đoạn ngân sách. Bạn có thể sử dụng URL này để nhập thông tin Đơn đặt hàng cho từng phân đoạn ngân sách và in thông tin đó trên hoá đơn.

Phải được mã hoá UTF-8.
dateRange

object (DateRange)

Bắt buộc. Chế độ cài đặt ngày bắt đầu và ngày kết thúc của phân đoạn ngân sách. Các khoảng thời gian này được phân giải theo múi giờ của nhà quảng cáo mẹ.

  • Khi bạn tạo một phân đoạn ngân sách mới, cả startDate và endDate đều phải ở trong tương lai.
  • Một phân đoạn ngân sách hiện tại có startDate trong quá khứ có endDate có thể thay đổi nhưng startDate không thể thay đổi.
  • endDate phải là startDate trở lên, cả hai đều trước năm 2037.
campaignBudgetId

string (int64 format)

budgetId của ngân sách chiến dịch chứa phân khúc ngân sách đơn đặt hàng quảng cáo này.

BillableOutcome

Các kết quả có thể lập hoá đơn cho một đơn đặt hàng quảng cáo.

Enum
BILLABLE_OUTCOME_UNSPECIFIED Kết quả có thể lập hoá đơn chưa xác định.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Trả tiền cho mỗi lần hiển thị.
BILLABLE_OUTCOME_PAY_PER_CLICK

Trả tiền cho mỗi lượt nhấp.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Thanh toán cho mỗi chế độ xem đang kích hoạt.

Phương thức

create

 Tạo một đơn đặt hàng quảng cáo mới.

delete

 Xoá một đơn đặt hàng quảng cáo.

get

 Lấy đơn đặt hàng quảng cáo.

list

 Liệt kê các đơn đặt hàng quảng cáo trong một nhà quảng cáo.

listAssignedTargetingOptions

 Liệt kê các lựa chọn nhắm mục tiêu được chỉ định của một đơn đặt hàng quảng cáo trên các loại tiêu chí nhắm mục tiêu.

patch

 Cập nhật một đơn đặt hàng quảng cáo hiện có.