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),

  // 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 خاص بالمعلِن.
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

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

الطُرق

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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