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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
שדות
performanceGoalType

enum (PerformanceGoalType)

חובה. סוג יעד הביצועים.
חובה. שווי יעד הביצועים שמתאים לערך performance_goal_type נתון. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
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.

הסכום מצוין ב-Micros. הערך חייב להיות גדול מ-0 או שווה ל-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)

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

הסכום מצוין ב-Micros. הערך חייב להיות גדול מ-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

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