REST Resource: guaranteedOrders

{
  "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.
}

string

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

string

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

enum ( Exchange )

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

string

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

string

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

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

object ( GuaranteedOrderStatus )

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

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

string

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

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

boolean

آیا همه تبلیغ‌کنندگان readWritePartnerId به سفارش تضمین‌شده دسترسی خواندنی دارند یا خیر. فقط در صورتی قابل اجرا است که readWritePartnerId تنظیم شده باشد. اگر درست باشد، readAdvertiserIds را لغو می‌کند.

string ( int64 format)

شناسه آگهی دهندگان با دسترسی خواندنی به سفارش تضمین شده.

اگر تنظیم شده باشد، این فیلد نباید شامل تبلیغ کننده ای باشد که به readWriteAdvertiserId اختصاص داده شده است. همه تبلیغ‌کنندگان در این زمینه باید متعلق به readWritePartnerId یا شریک مشابه readWriteAdvertiserId باشند.

string ( int64 format)

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

تبلیغ‌کننده پیش‌فرض یا readWriteAdvertiserId است یا اگر تنظیم نشده باشد، اولین تبلیغ‌کننده فهرست‌شده در readAdvertiserIds است. در غیر این صورت، هیچ تبلیغ کننده پیش فرضی وجود ندارد.

string ( int64 format)

شناسه کمپین پیش فرض که به سفارش تضمین شده اختصاص داده شده است.

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

string ( int64 format)

شریک با دسترسی خواندن/نوشتن به سفارش تضمین شده.

string ( int64 format)

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

{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}

enum ( EntityStatus )

اینکه آیا سفارش تضمین شده قابل ارائه است یا خیر.

مقادیر قابل قبول ENTITY_STATUS_ACTIVE ، ENTITY_STATUS_ARCHIVED و ENTITY_STATUS_PAUSED هستند. مقدار پیش‌فرض ENTITY_STATUS_ACTIVE است.

string

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

باید UTF-8 با طول حداکثر 100 بایت کدگذاری شود.

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

enum ( GuaranteedOrderConfigStatus )

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

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

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