משאב: GuaranteedOrder
הזמנה מובטחת.
הזמנות מובטחות הן ישות הורה של מקורות מלאי שטחי פרסום מובטח. כשיוצרים מקור של מלאי שטחי פרסום מובטח, צריך להקצות למקור מלאי שטחי הפרסום מזהה הזמנה מובטחת.
ייצוג ב-JSON |
---|
{ "name": string, "legacyGuaranteedOrderId": string, "exchange": enum ( |
שדות | |
---|---|
name |
פלט בלבד. שם המשאב של ההזמנה המובטחת. |
legacyGuaranteedOrderId |
פלט בלבד. המזהה הקודם של ההזמנה המובטחת. הוקצה על ידי פלטפורמת ה-Exchange המקורית. המזהה הקודם הוא ייחודי בתוך המרות מסוימות, אבל אין ערובה שהוא יהיה ייחודי בכל ההזמנות המובטחות. המזהה הזה משמש ב-SDF ובממשק המשתמש. |
exchange |
חובה. לא ניתן לשינוי. בורסת הקריפטו שממנה הגיעה ההזמנה המובטחת. |
guaranteedOrderId |
פלט בלבד. המזהה הייחודי של ההזמנה המובטחת. מספרי ההזמנות המבטיחים מופיעים בפורמט |
displayName |
חובה. השם המוצג של ההזמנה המובטחת. הקידוד חייב להיות UTF-8 והגודל המקסימלי הוא 240 בייטים. |
status |
הגדרות הסטטוס של ההזמנה עם ההתחייבות למשלוח מהיר. |
updateTime |
פלט בלבד. חותמת הזמן של מועד העדכון האחרון של ההזמנה המובטחת. המערכת מקצה את השם. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
publisherName |
חובה. שם המוציא לאור של ההזמנה המובטחת. הקידוד חייב להיות UTF-8 והגודל המקסימלי הוא 240 בייטים. |
readAccessInherited |
אם לכל המפרסמים ב- |
readAdvertiserIds[] |
המזהים של המפרסמים שיש להם הרשאת קריאה להזמנה המובטחת. אם השדה הזה מוגדר, אסור לכלול בו את המפרסם שהוקצה ל- |
defaultAdvertiserId |
פלט בלבד. המזהה של מפרסם ברירת המחדל של ההזמנה המובטחת. המפרסם שמוגדר כברירת מחדל הוא |
defaultCampaignId |
המזהה של קמפיין ברירת המחדל שהוקצה להזמנה מובטחת. קמפיין ברירת המחדל חייב להיות שייך למפרסם ברירת המחדל. |
שדה האיחוד השותף או המפרסם שיש להם הרשאת קריאה/כתיבה להזמנה המובטחת. הערך של |
|
readWritePartnerId |
השותף שיש לו גישת קריאה/כתיבה להזמנה המובטחת. |
readWriteAdvertiserId |
המפרסם שיש לו גישת קריאה/כתיבה להזמנה המובטחת. זהו גם המפרסם שמוגדר כברירת מחדל בהזמנה המובטחת. |
GuaranteedOrderStatus
הגדרות הסטטוס של ההזמנה עם ההתחייבות למשלוח מהיר.
ייצוג ב-JSON |
---|
{ "entityStatus": enum ( |
שדות | |
---|---|
entityStatus |
האם ניתן להציג את ההזמנה המובטחת או לא. הערכים הקבילים הם |
entityPauseReason |
הסיבה שהמשתמש סיפק להשהיית ההזמנה המובטחת. הקידוד חייב להיות UTF-8 באורך מקסימלי של 100 בייטים. רלוונטי רק כשהערך של |
configStatus |
פלט בלבד. סטטוס ההגדרה של ההזמנה המובטחת. הערכים הקבילים הם כדי שאפשר יהיה להציג את ההזמנה, צריך להגדיר אותה (למלא את השדות הנדרשים, לבחור נכסי קריאייטיב ולבחור קמפיין ברירת מחדל). בשלב זה, אפשר לבצע את פעולת ההגדרה רק דרך ממשק המשתמש. |
GuaranteedOrderConfigStatus
מצבי ההגדרה האפשריים של הזמנה מובטחת.
טיפוסים בני מנייה (enum) | |
---|---|
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED |
סטטוס האישור לא צוין או לא ידוע בגרסה הזו. |
PENDING |
המצב ההתחלתי של הזמנה מובטחת. כדי שההזמנה המובטחת תוכל להופיע, צריך להגדיר אותה במצב הזה. |
COMPLETED |
הסטטוס אחרי שהקונה מגדיר הזמנה מובטחת. |
Methods |
|
---|---|
|
יצירת הזמנה מובטחת חדשה. |
|
עריכות קוראות למפרסמים על הזמנה מובטחת. |
|
מקבל הזמנה מובטחת. |
|
רשימה של הזמנות מובטחות שזמינות למשתמש הנוכחי. |
|
עדכון של הזמנה מובטחת קיימת. |