REST Resource: advertisers.insertionOrders

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}

string

פלט בלבד. שם המשאב של הזמנת הקמפיין.

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

חובה. השם המוצג של הזמנת הקמפיין.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 240 בייטים.

enum (InsertionOrderType)

הסוג של הזמנת הקמפיין.

אם השדה הזה לא צוין ביצירה, ברירת המחדל של הערך תהיה RTB.

enum (EntityStatus)

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

• בשיטה insertionOrders.create אפשר להשתמש רק ב-ENTITY_STATUS_DRAFT. כדי להפעיל הזמנת קמפיין, צריך להשתמש בשיטת insertionOrders.patch ולעדכן את הסטטוס ל-ENTITY_STATUS_ACTIVE לאחר היצירה.
• אי אפשר לשנות את הסטטוס של הזמנת קמפיין חזרה לסטטוס ENTITY_STATUS_DRAFT מכל סטטוס אחר.
• אי אפשר להגדיר הזמנת קמפיין בתור ENTITY_STATUS_ACTIVE אם הקמפיין הראשי שלה לא פעיל.

string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

object (PartnerCost)

העלויות של השותף שמשויכות להזמנת הקמפיין.

אם היא חסרה או ריקה בשיטה insertionOrders.create, הזמנת הקמפיין החדשה תירש את עלויות השותף מהגדרות השותף.

object (Pacing)

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

object (FrequencyCap)

חובה. הגדרת מכסת התדירות של הזמנת הקמפיין.

object (IntegrationDetails)

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

object (PerformanceGoal)

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

שיטת הבידינג של הזמנת הקמפיין. כברירת מחדל, fixedBid מוגדר.

enum (ReservationType)

פלט בלבד. סוג ההזמנה של הזמנת הקמפיין.

enum (BillableOutcome)

בלתי ניתן לשינוי. התוצאה הניתנת לחיוב של הזמנת הקמפיין.

הקנייה מבוססת-תוצאות הוצאה משימוש. BILLABLE_OUTCOME_PAY_PER_IMPRESSION הוא הערך החוקי היחיד.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

חובה. בלתי ניתן לשינוי. יחידת התקציב מציינת אם התקציב מבוסס על מטבע או על סמך חשיפות.

enum (InsertionOrderAutomationType)

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

אם השדה הזה לא צוין ביצירה, ברירת המחדל של הערך תהיה INSERTION_ORDER_AUTOMATION_TYPE_NONE.

object (InsertionOrderBudgetSegment)

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

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string (int64 format)

חובה. סכום התקציב שיושלם על ידי הזמנת הקמפיין עבור dateRange הנתון. הסכום הוא במיליוניות השנייה. חייב להיות גדול מ-0. לדוגמה, המספר 500000000 מייצג 500 יחידות רגילות של המטבע.

string

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

חייב להיות בקידוד UTF-8.

object (DateRange)

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

• כשיוצרים פלח תקציב חדש, צריך להגדיר את startDate וגם את endDate בעתיד.
• לפלח תקציב קיים שהוגדר לו startDate בעבר יש endDate שניתן לשנות, אבל startDate שלא ניתן לשינוי.
• endDate חייב להיות startDate ואילך, שניהם לפני שנת 2037.

string (int64 format)

השדה budgetId של תקציב הקמפיין שפלח התקציב הזה של הזמנת הקמפיין נכלל בו.