REST Resource: advertisers.insertionOrders

משאב: InsertionOrder

הזמנת קמפיין אחת.

ייצוג JSON 
{
  "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)
}
שדות
name

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (InsertionOrderType)

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

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

enum (EntityStatus)

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

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

string (Timestamp format)

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

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

object (PartnerCost)

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

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

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (PerformanceGoal)

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

object (InsertionOrderBudget)

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

object (BiddingStrategy)

שיטת הבידינג של הזמנת הקמפיין. ברירת המחדל היא fixedBid.
reservationType

enum (ReservationType)

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

enum (BillableOutcome)

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

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

InsertionOrderType

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

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

טיפוסים בני מנייה (enums)
INSERTION_ORDER_TYPE_UNSPECIFIED הסוג של הזמנת הקמפיין לא צוין או שהוא לא ידוע.
RTB בידינג בזמן אמת.
OVER_THE_TOP ישירות ללקוח.

InsertionOrderBudget

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

ייצוג JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
שדות
budgetUnit

enum (BudgetUnit)

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

enum (InsertionOrderAutomationType)

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

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

object (InsertionOrderBudgetSegment)

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

InsertionOrderAutomationType

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

טיפוסים בני מנייה (enums)
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED אפשרות האוטומציה של הזמנת הקמפיין לא צוינה או שהיא לא ידועה בגרסה הזו.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET הקצאת תקציב אוטומטית. המערכת יכולה להעביר באופן אוטומטי את התקציב לבעלות על פריטים, כדי לשפר את הביצועים שהוגדרו על ידי performanceGoal. אין אוטומציה בהגדרות של הצעות המחיר.
INSERTION_ORDER_AUTOMATION_TYPE_NONE אין אוטומציה של הצעת המחיר או התקציב ברמת הזמנת הקמפיין. צריך להגדיר ידנית את הצעת המחיר והתקציב ברמת הפריט.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET מתן אפשרות למערכת להתאים את הצעות המחיר באופן אוטומטי ולהעביר את התקציב לבעלות על פריטים כדי לבצע אופטימיזציה לביצועים לפי performanceGoal.

InsertionOrderBudgetSegment

הגדרות שקובעות את התקציב של פלח תקציב יחיד.

ייצוג JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
שדות
budgetAmountMicros

string (int64 format)

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

string

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

בקידוד UTF-8.
dateRange

object (DateRange)

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

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

string (int64 format)

הערך budgetId של תקציב הקמפיין שנכלל בפלח התקציב של הזמנת הקמפיין.

BillableOutcome

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

טיפוסים בני מנייה (enums)
BILLABLE_OUTCOME_UNSPECIFIED תוצאה לא מוגדרת לחיוב.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION תשלום לפי חשיפות.
BILLABLE_OUTCOME_PAY_PER_CLICK

תשלום לקליק.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

תשלום לפי צפייה פעילה.

שיטות

create

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

delete

 מחיקה של הזמנת קמפיין.

get

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

list

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

listAssignedTargetingOptions

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

patch

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