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

النتائج فقط. المعرّف القديم للطلب المضمون. يتم تحديدها من خلال سوق التداول الأصلي. يكون المعرّف القديم فريدًا في عملية تبادل واحدة، ولكن ليس من المضمون أن يكون فريدًا في جميع الطلبات المضمونة. يُستخدَم هذا المعرّف في "تنسيق بيانات خدمة Google" وواجهة المستخدم.
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

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