REST Resource: customBiddingAlgorithms

ทรัพยากร: CustomBidAlgorithm

อัลกอริทึมการเสนอราคาที่กำหนดเองรายการเดียว

การแสดง 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.
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อแหล่งข้อมูลของอัลกอริทึมการเสนอราคาที่กำหนดเอง
customBiddingAlgorithmId

string (int64 format)

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของอัลกอริทึมการเสนอราคาที่กำหนดเอง กำหนดโดยระบบ
displayName

string

ต้องระบุ ชื่อที่แสดงของอัลกอริทึมการเสนอราคาที่กำหนดเอง

ต้องเป็น UTF-8 ที่เข้ารหัสขนาดไม่เกิน 240 ไบต์
entityStatus

enum (EntityStatus)

ควบคุมว่าจะสามารถใช้อัลกอริทึมการเสนอราคาที่กำหนดเองเป็นกลยุทธ์การเสนอราคาได้หรือไม่

โดยค่าที่ยอมรับมีดังต่อไปนี้

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ประเภทอัลกอริทึมการเสนอราคาที่กำหนดเอง
sharedAdvertiserIds[]

string (int64 format)

รหัสของผู้ลงโฆษณาที่มีสิทธิ์เข้าถึงอัลกอริทึมนี้ หากตั้งค่าเป็น advertiserId ช่องนี้จะประกอบด้วยค่านั้นเท่านั้น

ระบบจะไม่ตั้งค่าช่องนี้หากอัลกอริทึม owner เป็นพาร์ทเนอร์และดึงข้อมูลโดยใช้ผู้ลงโฆษณา accessor
modelDetails[]

object (CustomBiddingModelDetails)

เอาต์พุตเท่านั้น รายละเอียดรูปแบบการเสนอราคาที่กำหนดเองสำหรับผู้ลงโฆษณาแต่ละรายที่มีสิทธิ์เข้าถึง

ช่องนี้อาจมีเฉพาะรายละเอียดของผู้ลงโฆษณาที่ค้นหาหากอัลกอริทึม owner เป็นพาร์ทเนอร์และดึงข้อมูลโดยใช้ผู้ลงโฆษณา accessor
ฟิลด์สหภาพ owner ระบุเอนทิตี DV360 ที่เป็นเจ้าของอัลกอริทึมการเสนอราคาที่กำหนดเอง บุคคลดังกล่าวอาจเป็นพาร์ทเนอร์หรือผู้ลงโฆษณาก็ได้ owner ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
partnerId

string (int64 format)

เปลี่ยนแปลงไม่ได้ รหัสที่ไม่ซ้ำกันของพาร์ทเนอร์ที่เป็นเจ้าของอัลกอริทึมการเสนอราคาที่กำหนดเอง
advertiserId

string (int64 format)

เปลี่ยนแปลงไม่ได้ รหัสที่ไม่ซ้ำกันของผู้ลงโฆษณาที่เป็นเจ้าของอัลกอริทึมการเสนอราคาที่กำหนดเอง

CustomBiddingAlgorithmType

ประเภทอัลกอริทึมการเสนอราคาที่กำหนดเองที่เป็นไปได้

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทอัลกอริทึมหรือไม่ทราบประเภทในเวอร์ชันนี้
SCRIPT_BASED อัลกอริทึมที่สร้างขึ้นผ่านไฟล์สคริปต์การเสนอราคาที่กำหนดเองซึ่งลูกค้าอัปโหลด
ADS_DATA_HUB_BASED อัลกอริทึมที่สร้างผ่านผลิตภัณฑ์ Ads Data Hub
GOAL_BUILDER_BASED อัลกอริทึมที่สร้างขึ้นผ่านเครื่องมือสร้างเป้าหมายใน UI ของ DV3
RULE_BASED

อัลกอริทึมตามกฎที่กําหนด กฎเหล่านี้จะกำหนดไว้ใน API โดยใช้ออบเจ็กต์ AlgorithmRules

อัลกอริทึมประเภทนี้จะใช้ได้กับลูกค้าที่อยู่ในรายการที่อนุญาตเท่านั้น ลูกค้ารายอื่นที่พยายามใช้ประเภทนี้จะได้รับข้อผิดพลาด

CustomBiddingModelDetails

รายละเอียดรูปแบบอัลกอริทึมการเสนอราคาที่กําหนดเองสำหรับผู้ลงโฆษณาที่แชร์รายเดียว

การแสดง JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
ช่อง
advertiserId

string (int64 format)

รหัสที่ไม่ซ้ำกันของผู้ลงโฆษณาที่เกี่ยวข้อง
readinessState

enum (ReadinessState)

สถานะความพร้อมของรูปแบบการเสนอราคาที่กำหนดเอง
suspensionState

enum (SuspensionState)

เอาต์พุตเท่านั้น สถานะการระงับของรูปแบบการเสนอราคาที่กำหนดเอง

ReadinessState

สถานะความพร้อมของโมเดลที่เป็นไปได้

Enum
READINESS_STATE_UNSPECIFIED ไม่ได้ระบุสถานะหรือไม่ทราบสถานะในเวอร์ชันนี้
READINESS_STATE_ACTIVE โมเดลได้รับการฝึกและพร้อมให้บริการแล้ว
READINESS_STATE_INSUFFICIENT_DATA มีข้อมูลไม่เพียงพอที่จะฝึกโมเดลการแสดงผล
READINESS_STATE_TRAINING โมเดลกําลังฝึกอยู่และไม่พร้อมให้บริการ
READINESS_STATE_NO_VALID_SCRIPT ไม่ได้ระบุสคริปต์การเสนอราคาที่กำหนดเองที่ถูกต้องไว้ใช้ฝึกโมเดล สถานะนี้จะมีผลกับอัลกอริทึมที่ customBiddingAlgorithmType เป็น SCRIPT_BASED เท่านั้น
READINESS_STATE_EVALUATION_FAILURE มีการใช้สคริปต์ที่ถูกต้องแต่การประเมินไม่ผ่าน ซึ่งมีไว้สำหรับสคริปต์ที่ประเมินไม่ได้ในเวลาที่กำหนด

SuspensionState

สถานะการระงับที่เป็นไปได้ของรูปแบบการเสนอราคาที่กำหนดเอง

Enum
SUSPENSION_STATE_UNSPECIFIED ไม่ได้ระบุสถานะหรือไม่ทราบสถานะในเวอร์ชันนี้
SUSPENSION_STATE_ENABLED โมเดลเปิดใช้อยู่ ไม่ว่าจะใช้งานล่าสุด ใช้งานอยู่ หรือมีกําหนดเวลาให้ใช้งาน อัลกอริทึมกําลังให้คะแนนการแสดงผลสําหรับผู้ลงโฆษณารายนี้
SUSPENSION_STATE_DORMANT ไม่มีการใช้โมเดลเมื่อเร็วๆ นี้ แม้ว่าโมเดลจะยังคงทำหน้าที่เป็น ENABLED แต่ท้ายที่สุดก็จะถูกระงับการใช้งานหากไม่ได้ใช้งาน
SUSPENSION_STATE_SUSPENDED โมเดลถูกระงับไม่ให้คะแนนการแสดงผลและไม่สามารถแสดงผล หากมีการกำหนดอัลกอริทึมให้กับรายการโฆษณาภายใต้ผู้ลงโฆษณารายนี้หรือมีการอัปเดต อัลกอริทึมจะเปลี่ยนกลับไปเป็นสถานะ ENABLED และจะต้องใช้เวลาในการเตรียมรูปแบบการแสดงโฆษณาอีกครั้ง

เมธอด

create

 สร้างอัลกอริทึมการเสนอราคาที่กำหนดเองใหม่

get

 รับอัลกอริทึมการเสนอราคาที่กําหนดเอง

list

 แสดงรายการอัลกอริทึมการเสนอราคาที่กำหนดเองที่ผู้ใช้ปัจจุบันเข้าถึงได้และใช้ได้ในกลยุทธ์การเสนอราคา

patch

 อัปเดตอัลกอริทึมการเสนอราคาที่กำหนดเองที่มีอยู่

uploadRules

 สร้างออบเจ็กต์อ้างอิงกฎสำหรับไฟล์ AlgorithmRules

uploadScript

 สร้างออบเจ็กต์อ้างอิงสคริปต์การเสนอราคาที่กําหนดเองสำหรับไฟล์สคริปต์