REST Resource: customBiddingAlgorithms

Tài nguyên: Custom BiddingAlgorithm

Một thuật toán đặt giá thầu tuỳ chỉnh duy nhất.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của thuật toán đặt giá thầu tuỳ chỉnh.
customBiddingAlgorithmId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của thuật toán đặt giá thầu tuỳ chỉnh. Do hệ thống chỉ định.
displayName

string

Bắt buộc. Tên hiển thị của thuật toán đặt giá thầu tuỳ chỉnh.

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

enum (EntityStatus)

Kiểm soát việc có thể sử dụng thuật toán đặt giá thầu tuỳ chỉnh làm chiến lược đặt giá thầu hay không.

Các giá trị được chấp nhận là:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Bắt buộc. Bất biến. Loại thuật toán đặt giá thầu tuỳ chỉnh.
sharedAdvertiserIds[]

string (int64 format)

Mã nhận dạng của các nhà quảng cáo có quyền truy cập vào thuật toán này. Nếu bạn đặt advertiserId, trường này sẽ chỉ chứa giá trị đó.

Trường này sẽ không được thiết lập nếu thuật toán owner là một đối tác và đang được truy xuất bằng cách sử dụng nhà quảng cáo accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Chỉ có đầu ra. Thông tin chi tiết về các mô hình đặt giá thầu tuỳ chỉnh cho mỗi nhà quảng cáo có quyền truy cập.

Trường này chỉ có thể bao gồm thông tin chi tiết về nhà quảng cáo được truy vấn nếu thuật toán owner là một đối tác và đang được truy xuất bằng cách sử dụng nhà quảng cáo accessor.
Trường kết hợp owner. Xác định thực thể DV360 sở hữu thuật toán đặt giá thầu tuỳ chỉnh. Đó có thể là một đối tác hoặc nhà quảng cáo. owner chỉ có thể là một trong những trạng thái sau đây:
partnerId

string (int64 format)

Bất biến. Mã nhận dạng duy nhất của đối tác sở hữu thuật toán đặt giá thầu tuỳ chỉnh.
advertiserId

string (int64 format)

Bất biến. Mã nhận dạng duy nhất của nhà quảng cáo sở hữu thuật toán đặt giá thầu tuỳ chỉnh.

CustomBiddingAlgorithmType

Các loại thuật toán đặt giá thầu tuỳ chỉnh có thể có.

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Loại thuật toán chưa được chỉ định hoặc không xác định trong phiên bản này.
SCRIPT_BASED Thuật toán được tạo thông qua các tệp tập lệnh đặt giá thầu tuỳ chỉnh do khách hàng tải lên.
ADS_DATA_HUB_BASED Thuật toán được tạo thông qua sản phẩm Ads Data Hub.
GOAL_BUILDER_BASED Thuật toán được tạo thông qua trình tạo mục tiêu trong giao diện người dùng DV3.
RULE_BASED

Thuật toán dựa trên các quy tắc đã xác định. Các quy tắc này được xác định trong API bằng cách sử dụng đối tượng AlgorithmRules.

Loại thuật toán này chỉ dành cho khách hàng trong danh sách cho phép. Những khách hàng khác cố gắng sử dụng loại thẻ này sẽ gặp lỗi.

CustomBiddingModelDetails

Thông tin chi tiết về mô hình thuật toán đặt giá thầu tuỳ chỉnh cho một nhà quảng cáo dùng chung.

Biểu diễn dưới dạng JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Trường
advertiserId

string (int64 format)

Mã nhận dạng duy nhất của nhà quảng cáo có liên quan.
readinessState

enum (ReadinessState)

Trạng thái sẵn sàng của mô hình đặt giá thầu tuỳ chỉnh.
suspensionState

enum (SuspensionState)

Chỉ có đầu ra. Trạng thái tạm ngưng của mô hình đặt giá thầu tuỳ chỉnh.

ReadinessState

Các trạng thái có thể có về trạng thái sẵn sàng của mô hình.

Enum
READINESS_STATE_UNSPECIFIED Trạng thái chưa được chỉ định hoặc không xác định trong phiên bản này.
READINESS_STATE_ACTIVE Mô hình này đã được huấn luyện và sẵn sàng phân phát.
READINESS_STATE_INSUFFICIENT_DATA Không có đủ dữ liệu để huấn luyện mô hình phân phát.
READINESS_STATE_TRAINING Mô hình này đang được huấn luyện và chưa sẵn sàng phân phát.
READINESS_STATE_NO_VALID_SCRIPT Bạn chưa cung cấp tập lệnh đặt giá thầu tuỳ chỉnh hợp lệ để huấn luyện mô hình. Trạng thái này sẽ chỉ áp dụng cho các thuật toán có customBiddingAlgorithmType là SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Bạn đã cung cấp tập lệnh hợp lệ nhưng không đánh giá được. Điều này áp dụng cho các tập lệnh không đánh giá được trong thời gian phân bổ.

SuspensionState

Các trạng thái tạm ngưng có thể xảy ra của các mô hình đặt giá thầu tuỳ chỉnh.

Enum
SUSPENSION_STATE_UNSPECIFIED Trạng thái chưa được chỉ định hoặc không xác định trong phiên bản này.
SUSPENSION_STATE_ENABLED Mô hình đã được bật, đã sử dụng gần đây, hiện đã được sử dụng hoặc được lên lịch để sử dụng. Thuật toán đang tích cực tính điểm hiển thị cho nhà quảng cáo này.
SUSPENSION_STATE_DORMANT Mô hình không được sử dụng gần đây. Mặc dù vẫn đóng vai trò là ENABLED, nhưng mô hình đó cuối cùng sẽ bị tạm ngưng nếu không được sử dụng.
SUSPENSION_STATE_SUSPENDED Mô hình bị tạm ngưng tính điểm lượt hiển thị và không thể phân phát. Nếu thuật toán được chỉ định cho một mục hàng của nhà quảng cáo này hoặc được cập nhật thì thuật toán sẽ chuyển về trạng thái ENABLED và cần thời gian để chuẩn bị lại mô hình phân phát.

Phương thức

create

 Tạo thuật toán đặt giá thầu tuỳ chỉnh mới.

get

 Nhận thuật toán đặt giá thầu tuỳ chỉnh.

list

 Liệt kê các thuật toán đặt giá thầu tuỳ chỉnh mà người dùng hiện tại có thể truy cập và dùng trong các chiến lược đặt giá thầu.

patch

 Cập nhật thuật toán đặt giá thầu tuỳ chỉnh hiện có.

uploadRules

 Tạo đối tượng tham chiếu quy tắc cho tệp AlgorithmRules.

uploadScript

 Tạo đối tượng tham chiếu tập lệnh đặt giá thầu tuỳ chỉnh cho tệp tập lệnh.