REST Resource: guaranteedOrders

المورد: طلب مضمون

طلب مضمون

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

تمثيل 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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

 يؤدي هذا الإجراء إلى تعديل طلب حالي مضمون.