REST Resource: guaranteedOrders

משאב: AddressdOrder

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

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

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

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