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 مقدّم خدمة علوم بيانات خارجي يمكن لشركاء أو معلني "مساحة العرض والفيديو 360" التعاون معه
ADELAIDE مقدّم خدمة خارجي لقياس الانتباه يمكن لشركاء/معلني "مساحة العرض والفيديو 360" التعاون معه.

الطُرق

create

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

get

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

list

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

patch

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

uploadRules

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

uploadScript

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