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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
שדות
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)

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

object (Kpi)

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

היעד הזה נקרא "יעד" בממשק Display & Video 360.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

InsertionOrderType

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

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

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

KPI

הגדרות ששולטות במדדי הביצועים המרכזיים (KPI) של הזמנת הקמפיין.

ייצוג JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
שדות
kpiType

enum (KpiType)

חובה. סוג ה-KPI.
kpiAlgorithmId

string (int64 format)

זה שינוי אופציונלי. מזהה אלגוריתם של הצעת מחיר מותאמת אישית שמשויך אל KPI_CUSTOM_IMPRESSION_VALUE_OVER_cost. המערכת תתעלם מהשדה הזה אם לא נבחר ה-KPI המתאים.
שדה איחוד kpi_value. חובה. הערך של ה-KPI. השדה הרלוונטי תואם לשדה kpi_type. kpi_value יכול להיות רק אחד מהבאים:
kpiAmountMicros

string (int64 format)

סכום היעד, במיליוניות השנייה של המטבע של המפרסם.

תקף רק אם kpiType הוא אחד מהבאים:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

לדוגמה: 1500000 מייצג 1.5 יחידות רגילות של המטבע.
kpiPercentageMicros

string (int64 format)

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

תקף רק אם kpiType הוא אחד מהבאים:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

לדוגמה: 70,000 מייצג 7% (0.07 עשרוני).
kpiString

string

מחרוזת KPI, שיכולה להיות ריקה. חייב להיות בקידוד UTF-8, באורך של לא יותר מ-100 תווים.

תקף אם הערך של kpiType הוא KPI_TYPE_OTHER.

KpiType

סוגים אפשריים של אינדיקטור ביצועים מרכזיים (KPI).

טיפוסים בני מנייה (enums)
KPI_TYPE_UNSPECIFIED סוג ה-KPI לא צוין או שאינו ידוע בגרסה הזו.
KPI_TYPE_CPM ה-KPI הוא עלות לאלף חשיפות (CPM).
KPI_TYPE_CPC מדד ה-KPI הוא עלות לקליק (CPC).
KPI_TYPE_CPA מדד ה-KPI הוא עלות להמרה (CPA).
KPI_TYPE_CTR ה-KPI הוא אחוז שיעור הקליקים.
KPI_TYPE_VIEWABILITY ה-KPI הוא אחוז הניראות.
KPI_TYPE_CPIAVC ה-KPI הוא CPIAVC (עלות לחשיפה נשמעת וגלויה בסיום הצפייה).
KPI_TYPE_CPE ה-KPI הוא עלות לאינטראקציה ראשונית (CPE).
KPI_TYPE_CPV ה-KPI מוגדר בעלות לצפייה (CPV).
KPI_TYPE_CLICK_CVR ה-KPI הוא אחוז שיעור המרות קליקים (המרות לקליק).
KPI_TYPE_IMPRESSION_CVR ה-KPI הוא אחוז שיעור המרות הופעות (המרות לכל הופעה).
KPI_TYPE_VCPM ה-KPI הוא 'עלות לאלף חשיפות הניתנות לצפייה' (VCPM).
KPI_TYPE_VTR ה-KPI הוא אחוז שיעור הצפייה ב-YouTube (צפיות ב-YouTube לכל חשיפה).
KPI_TYPE_AUDIO_COMPLETION_RATE ה-KPI הוא שיעור השלמת האודיו (האזנות מלאות של אודיו לכל חשיפה).
KPI_TYPE_VIDEO_COMPLETION_RATE ה-KPI הוא אחוז שיעור השלמת הצפייה בסרטון (צפיות מלאות בסרטונים לכל חשיפה).
KPI_TYPE_CPCL ה-KPI מוגדר ב-CPCL (עלות לכל האזנה לאודיו).
KPI_TYPE_CPCV ה-KPI מוגדר ב-CPCV (עלות לצפייה מלאה בסרטון).
KPI_TYPE_TOS10 ה-KPI מוגדר לפי שיעור משך הצגה במסך של 10 שניות ומעלה (אחוז החשיפות שניתנות למדידה ולא ניתנות לדילוג, שהוצגו במסך למשך 10 שניות לפחות).
KPI_TYPE_MAXIMIZE_PACING מדד ה-KPI מוגדר למקסם את ההשפעה של המותג, תוך תעדוף ההוצאה של התקציב המלא.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST ה-KPI מוגדר בערך החשיפה המותאם אישית חלקי העלות.
KPI_TYPE_OTHER ה-KPI הוא ערך אחר.

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 הקצאת תקציב אוטומטית. המערכת יכולה להעביר באופן אוטומטי את התקציב לבעלות על פריטים, כדי לשפר את הביצועים שהוגדרו על ידי kpi. אין אוטומציה בהגדרות של הצעות המחיר.
INSERTION_ORDER_AUTOMATION_TYPE_NONE אין אוטומציה של הצעת המחיר או התקציב ברמת הזמנת הקמפיין. צריך להגדיר ידנית את הצעת המחיר והתקציב ברמת הפריט.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET מתן אפשרות למערכת להתאים את הצעות המחיר באופן אוטומטי ולהעביר את התקציב לבעלות על פריטים כדי לבצע אופטימיזציה לביצועים לפי kpi.

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 של תקציב הקמפיין שנכלל בפלח התקציב של הזמנת הקמפיין.

שיטות

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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