REST Resource: advertisers.insertionOrders

Tài nguyên: InsertionOrder

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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
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 mà đơn đặt hàng thuộc về.
campaignId

string (int64 format)

Bắt buộc. Không thể thay đổi. Mã nhận dạng duy nhất của chiến dịch mà đơn đặt hàng thuộc về.
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)

Không bắt buộc. 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, giá trị sẽ mặc định là RTB.
entityStatus

enum (EntityStatus)

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

  • Đối với phương thức insertionOrders.create, bạn chỉ được phép dùng ENTITY_STATUS_DRAFT. Để kích hoạt mộ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 trạng thái của đơn đặt hàng quảng cáo từ bất kỳ trạng thái nào khác về trạng thái ENTITY_STATUS_DRAFT.
  • Bạn không thể đặt đơn đặt hàng thành ENTITY_STATUS_ACTIVE nếu chiến dịch mẹ không hoạt động.
updateTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
partnerCosts[]

object (PartnerCost)

Không bắt buộc. Chi phí đối tác liên quan đến yêu cầu chèn.

Nếu không có hoặc trống trong phương thức insertionOrders.create, thì đơn đặt hàng mới tạo sẽ kế thừa chi phí của đối tác từ chế độ cài đặt đố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.

pacingType PACING_TYPE_ASAP không tương thích với pacingPeriod PACING_PERIOD_FLIGHT.
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)

Không bắt buộc. Thông tin chi tiết khác về việc tích hợp đơn đặt hàng quảng cáo.
kpi

object (Kpi)

Bắt buộc. Chỉ báo hiệu suất chính (KPI) của đơn đặt hàng quảng cáo.

Mục tiêu này được thể hiện dưới dạng "Mục tiêu" trong giao diện Display & Video 360.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

Không bắt buộc. Chiến lược đặt giá thầu của đơn đặt hàng. 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.
optimizationObjective

enum (OptimizationObjective)

Bắt buộc. Mục tiêu tối ưu hoá của đơn đặt hàng quảng cáo.

InsertionOrderType

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

Loại Lệnh chèn sẽ xác định những chế độ cài đặt và lựa chọn nào có thể áp dụng, chẳng hạn như định dạng của quảng cáo hoặc lựa chọn nhắm mục tiêu.

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

Kpi

Các chế độ cài đặt kiểm soát chỉ báo hiệu suất chính (KPI) của một đơn đặt hàng quảng cáo.

Biểu diễn dưới dạng 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.
}
Trường
kpiType

enum (KpiType)

Bắt buộc. Loại KPI.
kpiAlgorithmId

string (int64 format)

Không bắt buộc. Mã nhận dạng Thuật toán đặt giá thầu tuỳ chỉnh được liên kết với KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Trường này sẽ bị bỏ qua nếu bạn không chọn KPI phù hợp.
Trường nhóm kpi_value. Bắt buộc. Giá trị của KPI. Trường có liên quan tương ứng với kpi_type. kpi_value chỉ có thể là một trong những trạng thái sau:
kpiAmountMicros

string (int64 format)

Số tiền mục tiêu, tính bằng phần triệu đơn vị tiền tệ của nhà quảng cáo.

Áp dụng khi kpiType là một trong những giá trị sau:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Ví dụ: 1500000 biểu thị 1,5 đơn vị tiêu chuẩn của đơn vị tiền tệ.
kpiPercentageMicros

string (int64 format)

Giá trị thập phân của tỷ lệ phần trăm mục tiêu tính bằng phần triệu.

Áp dụng khi kpiType là một trong những giá trị sau:

  • 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

Ví dụ: 70000 biểu thị 7% (số thập phân 0,07).
kpiString

string

Một chuỗi KPI (có thể để trống). Phải được mã hoá UTF-8 và có độ dài không quá 100 ký tự.

Áp dụng khi kpiType là KPI_TYPE_OTHER.

KpiType

Các loại chỉ báo hiệu suất chính (KPI) có thể có.

Enum
KPI_TYPE_UNSPECIFIED Bạn chưa chỉ định hoặc chưa xác định được loại KPI trong phiên bản này.
KPI_TYPE_CPM KPI là CPM (chi phí mỗi nghìn lượt hiển thị).
KPI_TYPE_CPC KPI là CPC (chi phí mỗi lượt nhấp).
KPI_TYPE_CPA KPI là CPA (chi phí mỗi hành động).
KPI_TYPE_CTR KPI là tỷ lệ phần trăm CTR (tỷ lệ nhấp).
KPI_TYPE_VIEWABILITY KPI là Tỷ lệ phần trăm khả năng xem.
KPI_TYPE_CPIAVC KPI là CPIAVC (chi phí mỗi lượt hiển thị có thể nghe và có thể xem đến hết).
KPI_TYPE_CPE KPI là CPE (chi phí mỗi lượt tương tác).
KPI_TYPE_CPV KPI được đặt theo CPV (chi phí mỗi lượt xem).
KPI_TYPE_CLICK_CVR KPI là tỷ lệ phần trăm tỷ lệ chuyển đổi từ lượt nhấp (số lượt chuyển đổi trên mỗi lượt nhấp).
KPI_TYPE_IMPRESSION_CVR KPI là tỷ lệ chuyển đổi từ lượt hiển thị (số lượt chuyển đổi trên mỗi lượt hiển thị) tính theo tỷ lệ phần trăm.
KPI_TYPE_VCPM KPI là vCPM (chi phí mỗi nghìn lượt hiển thị có thể xem).
KPI_TYPE_VTR KPI này là tỷ lệ phần trăm tỷ lệ xem trên YouTube (số lượt xem trên YouTube cho mỗi lượt hiển thị).
KPI_TYPE_AUDIO_COMPLETION_RATE KPI là tỷ lệ phần trăm số lượt nghe hết phần âm thanh (số lượt nghe hết phần âm thanh trên mỗi lượt hiển thị).
KPI_TYPE_VIDEO_COMPLETION_RATE KPI là tỷ lệ phần trăm số lượt xem hết video (số lượt xem hết video trên mỗi lượt hiển thị).
KPI_TYPE_CPCL KPI được đặt trong CPCL (chi phí mỗi lượt nghe hết phần âm thanh).
KPI_TYPE_CPCV KPI được đặt trong CPCV (chi phí mỗi lượt xem hết video).
KPI_TYPE_TOS10 KPI này được đặt theo tỷ lệ thời gian hiển thị trên màn hình từ 10 giây trở lên (Tỷ lệ phần trăm số lượt hiển thị có thể đo lường và không thể bỏ qua đã hiển thị trên màn hình ít nhất 10 giây).
KPI_TYPE_MAXIMIZE_PACING KPI được đặt để tối đa hoá mức tác động của thương hiệu, đồng thời ưu tiên chi tiêu toàn bộ ngân sách.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI được đặt bằng giá trị lượt hiển thị tuỳ chỉnh chia cho chi phí.
KPI_TYPE_OTHER KPI là một giá trị khác.

InsertionOrderBudget

Chế độ cài đặt kiểm soát cách phân bổ ngân sách của đơ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. Không thể thay đổi. Đơn vị ngân sách chỉ định xem ngân sách dựa trên đơn vị tiền tệ hay dựa trên số lượt hiển thị.
automationType

enum (InsertionOrderAutomationType)

Không bắt buộc. Loại tính năng tự động hoá được dùng để quản lý giá thầu và ngân sách cho đơn đặt hàng.

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

object (InsertionOrderBudgetSegment)

Bắt buộc. Danh sách các phân đoạn ngân sách. Sử dụng phân đoạn ngân sách để chỉ định một ngân sách cụ thể cho 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ể có để tự động hoá giá thầu và ngân sách của đơn đặt hàng.

Enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED Bạn không chỉ định hoặc không biết lựa chọn tự động hoá đơn đặt hàng trong phiên bản này.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Phân bổ ngân sách tự động. Cho phép hệ thống tự động chuyển ngân sách sang các mục hàng thuộc sở hữu để tối ưu hoá hiệu suất do kpi xác định. Không có chế độ tự động hoá nào cho 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 các mục hàng thuộc sở hữu để tối ưu hoá hiệu suất theo kpi.

InsertionOrderBudgetSegment

Các chế độ cài đặt kiểm soát ngân sách của một phân khúc ngân sách duy nhất.

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ố tiền được tính bằng phần triệu. Phải lớn hơn 0. Ví dụ: 500000000 biểu thị 500 đơn vị tiêu chuẩn của đơn vị tiền tệ.
description

string

Không bắt buộc. Mô tả phân đoạn ngân sách. Bạn có thể dùng tính năng này để nhập thông tin Đơn đặt hàng cho từng phân khúc ngân sách và in thông tin đó trên hoá đơn.

Phải được mã hoá theo 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 giá trị này được phân giải theo múi giờ của nhà quảng cáo gốc.

  • Khi tạo một phân khúc 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 có có startDate trong quá khứ có thể thay đổi endDate nhưng không thể thay đổi startDate.
  • endDate phải là startDate hoặc muộn hơn, cả hai đều trước năm 2037.
campaignBudgetId

string (int64 format)

Không bắt buộc. budgetId ngân sách chiến dịch mà phân đoạn ngân sách của thứ tự chèn này thuộc về.

OptimizationObjective

Các loại mục tiêu tối ưu hoá có thể có.

Enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Bạn chưa chỉ định hoặc không xác định được giá trị loại trong phiên bản này.
CONVERSION Ưu tiên những lượt hiển thị giúp tăng doanh số bán hàng và lượt chuyển đổi.
CLICK Ưu tiên những lượt hiển thị giúp tăng lưu lượng truy cập vào trang web, ứng dụng và cửa hàng ứng dụng.
BRAND_AWARENESS Ưu tiên những lượt hiển thị có chất lượng cụ thể.
CUSTOM Mục tiêu được xác định bằng thuật toán đặt giá thầu tuỳ chỉnh được chỉ định.
NO_OBJECTIVE Chưa xác định được mục tiêu. Bạn có thể sử dụng mọi KPI hoặc chiến lược đặt giá thầu.

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 một đơn đặt hàng quảng cáo.

list

 Liệt kê các yêu cầu chèn của 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 hiện có.