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. تُحدِّد هذه السمة عنصر "مساحة العرض والفيديو 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 الخوارزمية التي تم إنشاؤها من خلال أداة إنشاء الأهداف في واجهة مستخدم DV3
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

 تُنشئ هذه الدالة عنصرًا مرجعيًا لنص عرض أسعار مخصّص لملف نص.