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,

  // 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)

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

הפונקציה משתמשת ב-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)

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

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

שדה איחוד 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 הסטטוס אחרי שהקונה מגדיר הזמנה עם הבטחה.

Methods

create

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

editGuaranteedOrderReadAccessors

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

get

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

list

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

patch

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