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

פלט בלבד. המזהה הקודם של ההזמנה המובטחת. הוקצה על ידי פלטפורמת ה-Exchange המקורית. המזהה הקודם הוא ייחודי בתוך המרות מסוימות, אבל אין ערובה שהוא יהיה ייחודי בכל ההזמנות המובטחות. המזהה הזה משמש ב-SDF ובממשק המשתמש.
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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

מצבי ההגדרה האפשריים של הזמנה מובטחת.

טיפוסים בני מנייה (enum)
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED סטטוס האישור לא צוין או לא ידוע בגרסה הזו.
PENDING המצב ההתחלתי של הזמנה מובטחת. כדי שההזמנה המובטחת תוכל להופיע, צריך להגדיר אותה במצב הזה.
COMPLETED הסטטוס אחרי שהקונה מגדיר הזמנה מובטחת.

Methods

create

 יצירת הזמנה מובטחת חדשה.

editGuaranteedOrderReadAccessors

 עריכות קוראות למפרסמים על הזמנה מובטחת.

get

 מקבל הזמנה מובטחת.

list

 רשימה של הזמנות מובטחות שזמינות למשתמש הנוכחי.

patch

 עדכון של הזמנה מובטחת קיימת.