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

  // 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.
שדה איחוד 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

לדוגמה: 70000 מייצג 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_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_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

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