REST Resource: guaranteedOrders

מקור: ProvidedOrder

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

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

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

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

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

שיטות

create

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

editGuaranteedOrderReadAccessors

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

get

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

list

 בתיבת הדו שיח הזו רשומים הזמנות עם התחייבות שיש למשתמש הנוכחי גישה אליהן.

patch

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