REST Resource: guaranteedOrders

المرجع: GuaranteedOrder

طلب مضمون

الطلبات المضمونة هي عنصر رئيسي لمصادر المستودع الإعلاني المضمون. عند إنشاء مصدر مستودع مضمون، يجب تخصيص معرّف طلب مضمون لمصدر المستودع.

تمثيل JSON 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
الحقول
name

string

النتائج فقط. اسم المورد للطلب المضمون.
legacyGuaranteedOrderId

string

النتائج فقط. المعرّف القديم للطلب المضمون. تم تعيينه من خلال عملية الصرف الأصلية. يكون المعرّف القديم فريدًا في عملية تبادل واحدة، ولكن لا يمكن ضمان أن يكون فريدًا في جميع الطلبات المضمونة. ويُستخدَم هذا المعرّف في SDF وواجهة المستخدم.
exchange

enum (Exchange)

مطلوب. غير قابل للتغيير الصرف الذي نشأ منه الطلب المضمون
guaranteedOrderId

string

النتائج فقط. المعرّف الفريد للطلب المضمون يكون تنسيق معرّفات الطلبات المضمونة على النحو التالي: {exchange}-{legacyGuaranteedOrderId}.
displayName

string

مطلوب. الاسم المعروض للطلب المضمون

يجب أن يكون بترميز UTF-8 بحد أقصى 240 بايت.
status

object (GuaranteedOrderStatus)

إعدادات حالة الطلب المضمون
updateTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لآخر تعديل على الطلب المضمون تمّ تعيينه من قِبل النظام.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
publisherName

string

مطلوب. اسم الناشر للطلب المضمون

يجب أن يكون بترميز UTF-8 بحد أقصى 240 بايت.
readAccessInherited

boolean

ما إذا كان لدى جميع المعلِنين في readWritePartnerId إذن بالاطّلاع على الطلب المضمون لا ينطبق ذلك إلا في حال ضبط readWritePartnerId. إذا كانت القيمة True، يتم إلغاء readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

أرقام تعريف المعلِنين الذين لديهم إذن بالقراءة للطلب المضمون

يجب ألا يتضمّن هذا الحقل المعلِن الذي تمّ تعيينه إلى readWriteAdvertiserId في حال ضبطه. يجب أن يكون جميع المعلِنين في هذا الحقل تابعين readWritePartnerId أو الشريك نفسه الذي يتبعه readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

النتائج فقط. رقم تعريف المعلِن التلقائي للطلب المضمون.

يكون المعلِن التلقائي هو readWriteAdvertiserId أو، في حال عدم ضبط هذا الخيار، المعلِن الأول المدرَج في readAdvertiserIds. أمّا في حال عدم تحديد المعلِن، فلن يكون هناك معلِن تلقائي.
defaultCampaignId

string (int64 format)

رقم تعريف الحملة التلقائية التي تمّ تعيينها للطلب المضمون.

يجب أن تنتمي الحملة التلقائية إلى المعلِن التلقائي.

حقل الربط read_write_accessor مطلوب.

الشريك أو المعلِن الذي لديه إذن بالقراءة/الكتابة في الطلب المضمون يمكن أن يكون read_write_accessor واحدًا مما يلي فقط:
readWritePartnerId

string (int64 format)

الشريك الذي لديه إذن بالقراءة/الكتابة في الطلب المضمون
readWriteAdvertiserId

string (int64 format)

المعلِن الذي لديه إذن بالقراءة/الكتابة في الطلب المضمون وهذا هو أيضًا المعلِن التلقائي للطلب المضمون.

GuaranteedOrderStatus

إعدادات حالة الطلب المضمون

تمثيل JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
الحقول
entityStatus

enum (EntityStatus)

ما إذا كان بالإمكان عرض الطلب المضمون أم لا

القيم المقبولة هي ENTITY_STATUS_ACTIVE وENTITY_STATUS_ARCHIVED وENTITY_STATUS_PAUSED. القيمة التلقائية هي ENTITY_STATUS_ACTIVE.
entityPauseReason

string

السبب الذي قدّمه المستخدم لإيقاف هذا الطلب المضمون مؤقتًا.

يجب أن تكون هذه القيمة مرمّزة بترميز UTF-8 وبحد أقصى 100 بايت.

لا ينطبق ذلك إلا عند ضبط entityStatus على ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

النتائج فقط. حالة الضبط للطلب المضمون.

القيم المقبولة هي PENDING وCOMPLETED.

يجب ضبط طلب مضمون (ملء الحقول المطلوبة واختيار تصميمات الإعلانات واختيار حملة تلقائية) قبل أن يتمكّن من العرض. لا يمكن حاليًا تنفيذ إجراء الضبط إلا من خلال واجهة المستخدم.

GuaranteedOrderConfigStatus

حالات الضبط المحتمَلة لطلب مضمون

عمليات التعداد
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED لم يتم تحديد حالة الموافقة أو هي غير معروفة في هذا الإصدار.
PENDING الحالة الأولى لطلب مضمون. يجب ضبط الطلب المضمون في هذه الحالة قبل أن يتم عرضه.
COMPLETED الحالة بعد أن يضبط المشتري طلبًا مضمونًا.

الطُرق

create

 لإنشاء طلب مضمون جديد.

editGuaranteedOrderReadAccessors

 تُقرأ التعديلات للمعلِنين عن طلب مضمون.

get

 الحصول على طلب مضمون

list

 يسرد الطلبات المضمونة التي يمكن للمستخدم الحالي الوصول إليها.

patch

 تعديل طلب مضمون حالي