REST Resource: customBiddingAlgorithms

ทรัพยากร: CustomBiddingAlgorithm

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

การแสดง 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 ของผู้ลงโฆษณา
ฟิลด์ Union 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_BASED เลิกใช้งานแล้ว อัลกอริทึมที่สร้างขึ้นผ่านผลิตภัณฑ์ Ads Data Hub
GOAL_BUILDER_BASED

เลิกใช้งานแล้ว: GOAL_BUILDER_BASED เลิกใช้งานแล้ว ไม่รองรับอีกต่อไป และแทนที่ด้วย RULE_BASED อัลกอริทึมที่สร้างผ่านเครื่องมือสร้างเป้าหมายใน UI ของ DV3

เราได้ย้ายข้อมูลอัลกอริทึมที่มีอยู่ประเภทนี้ไปยัง RULE_BASED แล้ว
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

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