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

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