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)

اختيارية: غير قابل للتغيير تحدّد هذه السمة شريك التحسين الخارجي الذي يدير هذه الخوارزمية.
تحدّد هذه السمة العنصر في "مساحة العرض والفيديو 360" الذي يملك خوارزمية عروض الأسعار المخصّصة. ويمكن أن يكون شريكًا أو معلنًا. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
partnerId

string (int64 format)

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

string (int64 format)

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

CustomBiddingAlgorithmType

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

عمليات التعداد
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED لم يتم تحديد نوع الخوارزمية أو أنّه غير معروف في هذا الإصدار.
SCRIPT_BASED خوارزمية تم إنشاؤها من خلال ملفات نصوص برمجية مخصّصة لعروض الأسعار حمّلها العميل
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 وستحتاج إلى وقت لإعداد نموذج العرض مجددًا.

ThirdPartyOptimizationPartnerType

أنواع شركاء التحسين المحتملة التابعة لجهات خارجية

عمليات التعداد
UNKNOWN لم يتم تحديد قيمة النوع أو أنّها غير معروفة في هذا الإصدار.
SCIBIDS مقدّم خدمة علوم البيانات التابع لجهة خارجية والذي يمكن لشركاء/معلِني DV3 التعاون معه
ADELAIDE مقدّم خدمة قياس الانتباه التابع لجهة خارجية والذي يمكن أن يتعاون معه شركاء/معلِنون في "مساحة العرض والفيديو 360".

الطُرق

create

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

get

 تعرض هذه الطريقة خوارزمية عروض أسعار مخصّصة.

list

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

patch

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

uploadRules

 تنشئ هذه السمة كائنًا مرجعيًا للقواعد لملف AlgorithmRules.

uploadScript

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