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 ובגודל של עד 240 בייטים.
status

object (GuaranteedOrderStatus)

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

string (Timestamp format)

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

השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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)

המזהה של קמפיין ברירת המחדל שמוקצה להזמנה המובטחת.

קמפיין ברירת המחדל חייב להיות שייך למפרסם שמוגדר כברירת מחדל.

חובה.

השותף או המפרסם עם הרשאת קריאה/כתיבה להזמנה המובטחת. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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

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