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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
الحقول
name

string

للعرض فقط. اسم المورد الخاص بالطلب المضمون
legacyGuaranteedOrderId

string

للعرض فقط. المعرّف القديم للطلب المضمون يتم تعيينه من خلال السوق الأصلي. يكون المعرّف القديم فريدًا ضمن سوق إعلانية واحدة، ولكن ليس من المضمون أن يكون فريدًا في جميع الطلبات المضمونة. يتم استخدام هذا المعرّف في ملفات البيانات المنظَّمة وواجهة المستخدم.
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. إذا كانت القيمة "صحيح"، يتم إلغاء readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

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

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

string (int64 format)

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

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

string (int64 format)

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

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

الحقل مطلوب.

الشريك أو المعلِن الذي لديه الإذن بالقراءة والتعديل لطلب مضمون في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
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

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