REST Resource: customBiddingAlgorithms

المرجع: خوارزمية عروض الأسعار المخصّصة

خوارزمية عروض أسعار مخصّصة واحدة.

تمثيل 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 تحدِّد كيان "مساحة العرض والفيديو 360" الذي يملك خوارزمية عروض الأسعار المخصّصة. قد يكون إما شريكًا أو معلنًا. يمكن أن يكون الحقل "owner" واحدًا فقط مما يلي:
partnerId

string (int64 format)

غير قابل للتغيير. رقم التعريف الفريد للشريك الذي يملك خوارزمية عروض الأسعار المخصّصة.
advertiserId

string (int64 format)

غير قابل للتغيير. رقم التعريف الفريد للمعلِن الذي يملك خوارزمية عروض الأسعار المخصّصة.

CustomBiddingAlgorithmType

الأنواع المحتملة من خوارزميات عروض الأسعار المخصّصة.

عمليات التعداد
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED نوع الخوارزمية غير محدّد أو غير معروف في هذا الإصدار.
SCRIPT_BASED الخوارزمية التي تم إنشاؤها من خلال ملفات النصوص البرمجية لعروض الأسعار المخصّصة التي يحمّلها العميل
ADS_DATA_HUB_BASED تم إنشاء الخوارزمية من خلال منتج Ads Data Hub.
GOAL_BUILDER_BASED خوارزمية تم إنشاؤها من خلال "أداة إنشاء الأهداف" في واجهة مستخدم "مساحة العرض والفيديو 3"

CustomBiddingModelDetails

تفاصيل نموذج خوارزمية عروض الأسعار المخصّصة لمعلِن مشترك واحد.

تمثيل JSON 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
الحقول
advertiserId

string (int64 format)

المعرّف الفريد للمعلِن ذي الصلة.
readinessState

enum (ReadinessState)

حالة جاهزية نموذج عروض الأسعار المخصّصة
suspensionState

enum (SuspensionState)

النتائج فقط. حالة تعليق نموذج عروض الأسعار المخصّصة.

ReadinessState

الحالات المحتملة لمدى جاهزية النموذج.

عمليات التعداد
READINESS_STATE_UNSPECIFIED لم يتم تحديد الولاية أو تكون غير معروفة في هذا الإصدار.
READINESS_STATE_ACTIVE يكون النموذج مدرّبًا وجاهزًا للعرض.
READINESS_STATE_INSUFFICIENT_DATA لا تتوفّر بيانات كافية لتدريب نموذج العرض.
READINESS_STATE_TRAINING النموذج قيد التدريب وليس جاهزًا للعرض.
READINESS_STATE_NO_VALID_SCRIPT لم يتم توفير نص برمجي صالح لعروض الأسعار المخصّصة لتدريب النموذج. لن يتم تطبيق هذه الحالة إلا على الخوارزميات التي تكون قيمة customBiddingAlgorithmType الخاصة بها SCRIPT_BASED.

SuspensionState

حالات تعليق محتملة لنماذج عروض الأسعار المخصّصة.

عمليات التعداد
SUSPENSION_STATE_UNSPECIFIED لم يتم تحديد الولاية أو تكون غير معروفة في هذا الإصدار.
SUSPENSION_STATE_ENABLED النموذج مفعَّل، وقد تم استخدامه مؤخرًا أو تم استخدامه حاليًا أو تم تحديد موعد لاستخدامه. تسجّل الخوارزمية بشكلٍ نشط مرات الظهور لهذا المعلِن.
SUSPENSION_STATE_DORMANT لم يتم استخدام النموذج مؤخرًا. مع أنّ النموذج لا يزال يعمل على أنّه ENABLED، سيتم تعليقه في النهاية إذا لم يتم استخدامه.
SUSPENSION_STATE_SUSPENDED تم تعليق النموذج من تسجيل مرات الظهور ولا يمكن عرضه. وفي حال تعيين الخوارزمية لعنصر ضمن هذا المعلِن أو تعديلها بأي شكل آخر، سيتم التبديل مرة أخرى إلى حالة ENABLED وسيتطلّب ذلك بعض الوقت لإعداد نموذج العرض مرّة أخرى.

الطُرق

create

 تُنشئ خوارزمية عروض أسعار مخصّصة جديدة.

get

 الحصول على خوارزمية عروض أسعار مخصّصة

list

 يسرد خوارزميات عروض الأسعار المخصّصة التي يمكن للمستخدم الحالي الوصول إليها ويمكن استخدامها في استراتيجيات عروض الأسعار.

patch

 تعديل خوارزمية عروض أسعار مخصّصة حالية

uploadScript

 تُنشئ كائنًا مرجعيًا لنص برمجي لعروض الأسعار المخصّصة لملف نص برمجي.