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 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

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

טיפוסים בני מנייה (enum)
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

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

טיפוסים בני מנייה (enum)
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

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

טיפוסים בני מנייה (enum)
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

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