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

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