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-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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 تنظیم شده باشد. اگر «درست» باشد، 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 کدبندی شده باشد و حداکثر طول آن ۱۰۰ بایت باشد.

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

enum (GuaranteedOrderConfigStatus)

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

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

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

GuaranteedOrderConfigStatus

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

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

روش‌ها

create

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

editGuaranteedOrderReadAccessors

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

get

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

list

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

patch

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