REST Resource: guaranteedOrders

משאב: מובטחת הזמנה

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

הזמנות מובטחות הן ישות הורה של מקורות מובטחים למלאי. כשיוצרים מקור מלאי מובטח, צריך להקצות מזהה הזמנה מובטח למקור המלאי.

ייצוג 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

פלט בלבד. המזהה הקודם של ההזמנה עם ההתחייבות. הוקצתה על ידי ההחלפה המקורית. המזהה הקודם הוא ייחודי במסגרת בורסה אחת, אבל לא מובטח שהוא יהיה ייחודי בכל ההזמנות עם התחייבות. המזהה הזה נמצא בשימוש ב-SDF ובממשק המשתמש.
exchange

enum (Exchange)

חובה. בלתי ניתן לשינוי. הבורסה שבה בוצעה ההזמנה עם ההתחייבות.
guaranteedOrderId

string

פלט בלבד. המזהה הייחודי של ההזמנה עם ההתחייבות. הפורמט של מזהי ההזמנה עם ההתחייבות היא {exchange}-{legacyGuaranteedOrderId}.
displayName

string

חובה. השם המוצג של ההזמנה עם ההתחייבות.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 240 בייטים.
status

object (GuaranteedOrderStatus)

הגדרות הסטטוס של ההזמנה עם ההתחייבות.
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של העדכון האחרון של ההזמנה עם ההתחייבות למחיר הנמוך ביותר. הוקצתה על ידי המערכת.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
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 המצב שאחרי הקונה מגדיר הזמנה מובטחת.

שיטות

create

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

editGuaranteedOrderReadAccessors

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

get

 מקבלים הזמנה עם התחייבות.

list

 בתיבת הדו-שיח הזו מפורטים הזמנות מובטחות שזמינות למשתמש הנוכחי.

patch

 עדכון הזמנה קיימת עם התחייבות.