REST Resource: customBiddingAlgorithms

แหล่งข้อมูล: CustomBiddingAlgorithm

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

การแสดง 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.
}
ช่อง
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 ของผู้ลงโฆษณา
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

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

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

Enum
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทอัลกอริทึมหรือไม่รู้จักในเวอร์ชันนี้
SCRIPT_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 และต้องใช้เวลาในการเตรียมรูปแบบการแสดงโฆษณาอีกครั้ง

ThirdPartyOptimizationPartnerType

ประเภทพาร์ทเนอร์การเพิ่มประสิทธิภาพบุคคลที่สามที่เป็นไปได้

Enum
UNKNOWN ไม่ได้ระบุค่าประเภทหรือไม่รู้จักในเวอร์ชันนี้
SCIBIDS ผู้ให้บริการด้านวิทยาศาสตร์ข้อมูลบุคคลที่สามที่พาร์ทเนอร์/ผู้ลงโฆษณา DV3 สามารถร่วมมือด้วย
ADELAIDE ผู้ให้บริการวัดผลความสนใจของบุคคลที่สามที่พาร์ทเนอร์/ผู้ลงโฆษณา DV3 สามารถร่วมมือด้วย

เมธอด

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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