REST Resource: guaranteedOrders

المرجع: الضمانdOrder

طلب مضمون.

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

تمثيل 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)

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

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
publisherName

string

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

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

boolean

ما إذا كان لدى جميع المعلنين في readWritePartnerId الإذن بالاطّلاع على الطلب المضمون ولا ينطبق ذلك إلا في حال ضبط سياسة readWritePartnerId. إذا كان الخيار "صحيح"، يتم إلغاء سياسة "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

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