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)
  },
  "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 sở hữu đơn đặt hàng chèn.
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 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.
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 gọi là "Mục tiêu" trong mục Hiển thị và Giao diện Video 360.
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.
optimizationObjective

enum (OptimizationObjective)

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

Trường này chỉ dành cho những khách hàng trong danh sách cho phép. Nếu khách hàng không có trong danh sách cho phép, trường này sẽ rỗng và nếu bạn cố gắng thiết lập thì trường này sẽ báo lỗi.

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.

Kpi

Các chế độ cài đặt kiểm soát chỉ báo hiệu suất chính (KPI) của đơ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ã 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 thích hợp.
Trường kết hợp 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 đây:
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:

  • 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ền tệ chuẩn.
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 micrô giây.

Áp dụng khi kpiType là một trong:

  • 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% (thập phân 0,07).
kpiString

string

Chuỗi KPI, có thể để trống. Phải dùng phương thức mã hoá UTF-8 với độ 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).

Enum
KPI_TYPE_UNSPECIFIED Loại KPI chưa được chỉ định hoặc không xác định 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à xem khi kết thúc).
KPI_TYPE_CPE KPI là CPE (chi phí mỗi lượt tương tác).
KPI_TYPE_CPV KPI được đặt theo đơn vị 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 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ệ phần trăm tỷ lệ chuyển đổi lượt hiển thị (số lượt chuyển đổi trên mỗi lượt hiển thị).
KPI_TYPE_VCPM KPI là VCPM (chi phí mỗi nghìn lượt hiển thị có thể xem).
KPI_TYPE_VTR KPI là tỷ lệ phần trăm tỷ lệ xem trên YouTube (lượt xem YouTube trên mỗi lượt hiển thị).
KPI_TYPE_AUDIO_COMPLETION_RATE KPI là tỷ lệ phần trăm tỷ lệ hoàn thành nội dung âm thanh (lượt nghe hết âm thanh trên mỗi lượt hiển thị).
KPI_TYPE_VIDEO_COMPLETION_RATE KPI là tỷ lệ phần trăm tỷ lệ xem hết video (lượt xem video hoàn chỉnh trên mỗi lượt hiển thị).
KPI_TYPE_CPCL KPI được thiết lập bằng CPCL (chi phí mỗi lượt nghe hết nội dung âm thanh).
KPI_TYPE_CPCV KPI được đặt theo CPCV (chi phí mỗi lượt xem video hoàn chỉnh).
KPI_TYPE_TOS10 KPI được đặt theo tỷ lệ thời gian xem 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, không thể bỏ qua đã xem trên màn hình trong ít nhất 10 giây).
KPI_TYPE_MAXIMIZE_PACING KPI được thiết lập để tối đa hoá 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ính bằng cách lấy giá trị lượt hiển thị tuỳ chỉnh chia cho chi phí.
KPI_TYPE_OTHER KPI là một số giá trị khác.

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. Không thể thay đổi. Đơ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 kpi 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 kpi 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.

OptimizationObjective

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

Enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Giá trị loại chưa được chỉ định hoặc không xác định 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à số lượt chuyển đổi.
CLICK Ưu tiên những lượt hiển thị làm tăng lưu lượng truy cập vào trang web, ứng dụng, cửa hàng ứng dụng.
BRAND_AWARENESS Ưu tiên 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 Không xác định được mục tiêu. Bạn có thể sử dụng bất kỳ KPI hoặc chiến lược đặt giá thầu nào.

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ó.