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)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
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

לדוגמה, הערך 1500,000 מייצג 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_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.

שיטות

create

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

delete

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

get

 מקבל קמפיין.

list

 בתיבת הדו-שיח הזו מפורטים קמפיינים של מפרסם.

listAssignedTargetingOptions

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

patch

 מעדכן קמפיין קיים.