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

فقط خروجی. شناسه قدیمی سفارش تضمین‌شده. توسط صرافی اصلی اختصاص داده شده است. شناسه قدیمی در یک صرافی منحصر به فرد است، اما تضمین نمی‌شود که در تمام سفارش‌های تضمین‌شده منحصر به فرد باشد. این شناسه در SDF و رابط کاربری استفاده می‌شود.

exchange

enum ( Exchange )

الزامی. تغییرناپذیر. صرافی که سفارش تضمین‌شده از آن سرچشمه گرفته است.

guaranteedOrderId

string

فقط خروجی. شناسه منحصر به فرد سفارش تضمین شده. شناسه‌های سفارش تضمین شده دارای قالب {exchange}-{legacyGuaranteedOrderId} هستند.

displayName

string

الزامی. نام نمایشی سفارش تضمین‌شده.

باید با کد UTF-8 و حداکثر اندازه ۲۴۰ بایت کدگذاری شود.

status

object ( GuaranteedOrderStatus )

تنظیمات وضعیت سفارش تضمین‌شده.

updateTime

string ( Timestamp format)

فقط خروجی. مهر زمانی آخرین به‌روزرسانی سفارش تضمین‌شده. توسط سیستم تعیین می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

publisherName

string

الزامی. نام ناشر سفارش تضمین‌شده.

باید با کد UTF-8 و حداکثر اندازه ۲۴۰ بایت کدگذاری شود.

readAccessInherited

boolean

آیا همه تبلیغ‌کنندگان readWritePartnerId دسترسی خواندن به سفارش تضمین‌شده را دارند یا خیر. فقط در صورتی قابل اجرا است که readWritePartnerId تنظیم شده باشد. اگر True باشد، 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)

تبلیغ‌کننده‌ای که دسترسی خواندن/نوشتن به سفارش تضمین‌شده را دارد. این همچنین تبلیغ‌کننده پیش‌فرض سفارش تضمین‌شده است.

پایان میدان‌های ناسازگار.

وضعیت سفارش تضمین‌شده

تنظیمات وضعیت سفارش تضمین‌شده.

نمایش 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 و حداکثر طول ۱۰۰ بایت کدگذاری شود.

فقط زمانی قابل اجرا است که entityStatus روی ENTITY_STATUS_PAUSED تنظیم شده باشد.

configStatus

enum ( GuaranteedOrderConfigStatus )

فقط خروجی. وضعیت پیکربندی سفارش تضمین‌شده.

مقادیر قابل قبول PENDING و COMPLETED هستند.

یک سفارش تضمین‌شده قبل از اینکه بتواند ارائه شود، باید پیکربندی شود (فیلدهای موردنیاز را پر کنید، طرح‌های تبلیغاتی را انتخاب کنید و یک کمپین پیش‌فرض را انتخاب کنید). در حال حاضر، عملیات پیکربندی فقط از طریق رابط کاربری قابل انجام است.

وضعیت پیکربندی سفارش تضمین‌شده

حالت‌های پیکربندی ممکن برای یک سفارش تضمین‌شده.

انوم‌ها
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED وضعیت تأیید در این نسخه مشخص نشده یا ناشناخته است.
PENDING وضعیت آغازین یک سفارش تضمین‌شده. سفارش تضمین‌شده در این وضعیت، قبل از اینکه بتواند سرویس‌دهی کند، باید پیکربندی شود.
COMPLETED وضعیت پس از اینکه خریدار سفارش تضمین‌شده را پیکربندی می‌کند.

روش‌ها

create

 یک سفارش تضمین‌شده جدید ایجاد می‌کند.

editGuaranteedOrderReadAccessors

 ویرایش‌ها تبلیغ‌کنندگان سفارش تضمین‌شده را می‌خوانند.

get

 سفارش تضمین شده دریافت می‌کند.

list

 لیست سفارش‌های تضمین‌شده‌ای که برای کاربر فعلی قابل دسترسی هستند را نشان می‌دهد.

patch

 یک سفارش تضمین‌شده موجود را به‌روزرسانی می‌کند.