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 خوارزمية تم إنشاؤها من خلال أداة إنشاء الأهداف في واجهة مستخدم "مساحة العرض والفيديو 360"
RULE_BASED

خوارزمية تستند إلى قواعد محدّدة يتم تحديد هذه القواعد في واجهة برمجة التطبيقات باستخدام الكائن AlgorithmRules.

لا يتوفّر هذا النوع من الخوارزمية إلا للعملاء المُدرَجين في القائمة المسموح بها. سيتلقى العملاء الآخرون الذين يحاولون استخدام هذا النوع رسالة خطأ.

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.
READINESS_STATE_EVALUATION_FAILURE تم تقديم نص برمجي صالح، ولكن تعذّر التقييم. ينطبق ذلك على النصوص البرمجية التي يتعذّر تقييمها في الوقت المخصّص.

SuspensionState

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

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

الطُرق

create

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

get

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

list

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

patch

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

uploadRules

 تُنشئ كائنًا مرجعيًا لقواعد لملف AlgorithmRules.

uploadScript

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