REST Resource: customBiddingAlgorithms

Tài nguyên: CustomBiddingAlgorithm

Một thuật toán đặt giá thầu tùy chỉnh.

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)
    }
  ],
  "thirdPartyOptimizationPartner": enum (ThirdPartyOptimizationPartnerType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
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á theo 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. Không thể thay đổi. Loại thuật toán đặt giá thầu tuỳ chỉnh.
sharedAdvertiserIds[]

string (int64 format)

Mã nhận dạng của những 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, thì trường này sẽ chỉ bao gồm giá trị đó.

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

object (CustomBiddingModelDetails)

Chỉ có đầu ra. Thông tin chi tiết về mô hình đặt giá thầu tuỳ chỉnh cho từng 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 accessor của nhà quảng cáo.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

Không bắt buộc. Không thể thay đổi. Chỉ định đối tác tối ưu hoá bên thứ ba quản lý thuật toán này.
Xác định pháp nhân DV360 sở hữu thuật toán đặt giá thầu tuỳ chỉnh. Đó có thể là đối tác hoặc nhà quảng cáo. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
partnerId

string (int64 format)

Không thể thay đổi. Mã nhận dạng duy nhất của đối tác sở hữu thuật toán đặt giá thầu tùy chỉnh.
advertiserId

string (int64 format)

Không thể thay đổi. 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.
Kết thúc các trường loại trừ lẫn nhau.

CustomBiddingAlgorithmType

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

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Loại thuật toán không đượ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 tùy chỉnh do khách hàng tải lên.
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 đối tượng AlgorithmRules.

Loại thuật toán này chỉ dành cho những khách hàng được đưa vào danh sách cho phép. Những khách hàng khác cố gắng sử dụng loại này sẽ nhận được thông báo lỗi.

CustomBiddingModelDetails

Thông tin chi tiết về mô hình thuật toán đặt giá thầu tùy chỉnh cho một nhà quảng cáo được chia sẻ.

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ó của mức độ sẵn sàng của mô hình.

Enum
READINESS_STATE_UNSPECIFIED Trạng thái không được chỉ định hoặc không xác định trong phiên bản này.
READINESS_STATE_ACTIVE Mô hình đã đượ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 tùy chỉnh hợp lệ để huấn luyện mô hình. Trạng thái này sẽ chỉ được áp dụng cho các thuật toán có customBiddingAlgorithmType là SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE Tập lệnh được cung cấp hợp lệ nhưng không đánh giá được. Điều này áp dụng cho những tập lệnh không thể đánh giá trong thời gian quy định.

SuspensionState

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

Enum
SUSPENSION_STATE_UNSPECIFIED Trạng thái không đượ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, được sử dụng gần đây, đang được sử dụng hoặc được lên lịch sử dụng. Thuật toán đang tích cực chấm điểm cho các lượt hiển thị của 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ù mô hình vẫn hoạt động như ENABLED, nhưng cuối cùng mô hình 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 chấm đ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 thuộc 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.

ThirdPartyOptimizationPartnerType

Các loại Đối tác tối ưu hoá bên thứ ba có thể có.

Enum
UNKNOWN Giá trị loại không được chỉ định hoặc không xác định trong phiên bản này.
SCIBIDS Nhà cung cấp dịch vụ khoa học dữ liệu bên thứ ba mà đối tác/nhà quảng cáo DV3 có thể hợp tác.
ADELAIDE Nhà cung cấp dịch vụ đo lường mức độ chú ý của bên thứ ba mà đối tác/nhà quảng cáo DV3 có thể hợp tác.

Phương thức

create

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

get

 Lấy 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à có thể 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.