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

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