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

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

enum (Exchange)

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

string

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

string

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

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

object (GuaranteedOrderStatus)

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

string (Timestamp format)

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

يستخدم RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 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

 تعدّل هذه الطريقة طلبًا مضمونًا حاليًا.