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.

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

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