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
ฟิลด์การรวม 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

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