REST Resource: advertisers.campaigns

משאב: קמפיין

קמפיין אחד.

ייצוג JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
שדות
name

string

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (EntityStatus)

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

  • הערכים הקבילים הם ENTITY_STATUS_ACTIVE,‏ ENTITY_STATUS_ARCHIVED ו-ENTITY_STATUS_PAUSED.
  • בשיטה campaigns.create, אי אפשר להשתמש בערך ENTITY_STATUS_ARCHIVED.
updateTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

חובה. המטרה של הקמפיין.
campaignFlight

object (CampaignFlight)

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

object (FrequencyCap)

חובה. הגדרת מכסת התדירות של הקמפיין.
campaignBudgets[]

object (CampaignBudget)

רשימת התקציבים שזמינים לקמפיין הזה.

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

CampaignGoal

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

ייצוג JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
שדות
campaignGoalType

enum (CampaignGoalType)

חובה. סוג היעד של הקמפיין.
performanceGoal

object (PerformanceGoal)

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

הערכים הקבילים של performanceGoalType הם:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

סוגים אפשריים של יעדים לקמפיינים.

טיפוסים בני מנייה (enum)
CAMPAIGN_GOAL_TYPE_UNSPECIFIED שווי היעד לא צוין או לא ידוע בגרסה הזו.
CAMPAIGN_GOAL_TYPE_APP_INSTALL הגדלת מספר התקנות האפליקציה או האינטראקציות.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS הגברת המוּדעוּת למותג או למוצר.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION הגדלת המכירות אופליין או המכירות בחנות.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION הגדלת מספר הפעולות אונליין או את מספר הכניסות.

PerformanceGoal

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

ייצוג JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
שדות
performanceGoalType

enum (PerformanceGoalType)

חובה. סוג יעד הביצועים.
שדה איחוד performance_goal_value. חובה. ערך יעד הביצועים שמתאים ל-performance_goal_type מסוים. הערך performance_goal_value יכול להיות רק אחד מהבאים:
performanceGoalAmountMicros

string (int64 format)

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

רלוונטי אם performanceGoalType הוא אחד מהבאים:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

לדוגמה, הערך 1500000 מייצג 1.5 יחידות סטנדרטיות של המטבע.
performanceGoalPercentageMicros

string (int64 format)

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

רלוונטי אם performanceGoalType הוא אחד מהבאים:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

לדוגמה, 70000 מייצג 7% (עשרוני 0.07).
performanceGoalString

string

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

רלוונטי כשהערך של performanceGoalType הוא PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

סוגים אפשריים של יעדי ביצועים.

טיפוסים בני מנייה (enum)
PERFORMANCE_GOAL_TYPE_UNSPECIFIED בגרסה הזו, סוג יעד הביצועים לא מצוין או לא ידוע.
PERFORMANCE_GOAL_TYPE_CPM יעד הביצועים מוגדר בשיטת התשלום CPM (עלות לאלף חשיפות).
PERFORMANCE_GOAL_TYPE_CPC יעד הביצועים מוגדר בעלות לקליק (CPC).
PERFORMANCE_GOAL_TYPE_CPA יעד הביצועים מוגדר לפי עלות להמרה (CPA).
PERFORMANCE_GOAL_TYPE_CTR יעד הביצועים מוגדר באחוזים של שיעור הקליקים (CTR).
PERFORMANCE_GOAL_TYPE_VIEWABILITY יעד הביצועים מוגדר באחוז הניראות.
PERFORMANCE_GOAL_TYPE_CPIAVC יעד הביצועים מוגדר כעלות לחשיפת אודיו וחשיפה ויזואלית בעת ההשלמה (CPIAVC).
PERFORMANCE_GOAL_TYPE_CPE יעד הביצועים מוגדר ב-CPE (עלות למעורבות).
PERFORMANCE_GOAL_TYPE_CPV יעד הביצועים מוגדר לפי עלות לצפייה (CPV).
PERFORMANCE_GOAL_TYPE_CLICK_CVR יעד הביצועים מוגדר באחוזים של שיעור המרה מקליקים (המרות לכל קליק).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR יעד הביצועים מוגדר באחוזים של שיעור ההמרה לחשיפה (המרות לכל חשיפה).
PERFORMANCE_GOAL_TYPE_VCPM יעד הביצועים מוגדר לפי עלות לאלף חשיפות שניתנות לצפייה (VCPM).
PERFORMANCE_GOAL_TYPE_VTR יעד הביצועים מוגדר באחוזים של שיעור הצפייה ב-YouTube (מספר הצפיות ב-YouTube לכל חשיפה).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE יעד הביצועים מוגדר באחוזים של שיעור השלמת ההאזנה (האזנה מלאה לאודיו לכל חשיפה).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE יעד הביצועים מוגדר באחוזים של שיעור השלמת הצפייה בסרטון (צפיות מלאות בסרטון לכל חשיפה).
PERFORMANCE_GOAL_TYPE_OTHER יעד הביצועים מוגדר כ'אחר'.

CampaignFlight

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

ייצוג JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
שדות
plannedSpendAmountMicros

string (int64 format)

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

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

object (DateRange)

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

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

CampaignBudget

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

ייצוג JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
שדות
budgetId

string (int64 format)

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

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

string

חובה. השם המוצג של התקציב.

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

enum (BudgetUnit)

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

string (int64 format)

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

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

object (DateRange)

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

התאריכים startDate ו-endDate חייבים להיות לפני שנת 2037.
externalBudgetSource

enum (ExternalBudgetSource)

חובה. המקור החיצוני של התקציב.
externalBudgetId

string

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

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

חייב להיות ייחודי בקמפיין.
invoiceGroupingId

string

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

אם השדה הזה מוגדר ורמת החשבונית של פרופיל החיוב התואם מוגדרת ל'מזהה קיבוץ חשבוניות לפי תקציב', כל externalBudgetId עם אותו invoiceGroupingId יקובצו באותה חשבונית.
prismaConfig

object (PrismaConfig)

מטא-נתונים נוספים לשימוש בכלי Mediaocean Prisma.

נדרש לתקציבים של Mediaocean.

המאפיין הזה רלוונטי רק למפרסמים ב-prismaEnabled.

ExternalBudgetSource

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

טיפוסים בני מנייה (enum)
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED בגרסה הזו, הערך של מקור התקציב החיצוני לא צוין או לא ידוע.
EXTERNAL_BUDGET_SOURCE_NONE לתקציב אין מקור חיצוני.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN מקור התקציב הוא Mediaocean.

PrismaConfig

הגדרות ספציפיות לכלי Mediaocean Prisma.

ייצוג JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
שדות
prismaType

enum (PrismaType)

חובה. סוג Prisma.
prismaCpeCode

object (PrismaCpeCode)

חובה. קודים רלוונטיים של לקוח, מוצר והצעת מחיר מהכלי Mediaocean Prisma.
supplier

string

חובה. הגורם שהקצה את התקציב הזה (DSP, אתר וכו').

PrismaType

סוגים אפשריים של תקציב Prisma.

טיפוסים בני מנייה (enum)
PRISMA_TYPE_UNSPECIFIED הסוג לא צוין או לא ידוע בגרסה הזו.
PRISMA_TYPE_DISPLAY סוג המסך.
PRISMA_TYPE_VIDEO סוג הסרטון.
PRISMA_TYPE_AUDIO סוג האודיו.
PRISMA_TYPE_SOCIAL סוג הרשת החברתית.
PRISMA_TYPE_FEE סוג העמלה.

PrismaCpeCode

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

ייצוג JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
שדות
prismaClientCode

string

קוד הלקוח ב-Prisma.
prismaProductCode

string

קוד המוצר ב-Prisma.
prismaEstimateCode

string

קוד הצעת המחיר ב-Prisma.

Methods

create

 יצירת קמפיין חדש.

delete

 מחיקה סופית של קמפיין.

get

 קבלת קמפיין.

list

 הפונקציה מחזירה רשימה של קמפיינים של מפרסם.

patch

 עדכון של קמפיין קיים.