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)

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

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

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

string (int64 format)

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

רלוונטי כאשר 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 Payments Center יש תמיכה בחיפוש ובסינון של שדות הרכיבים של הקוד הזה.

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

string

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

string

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

string

קוד ההצעה של Prisma.

שיטות

create

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

delete

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

get

 אחזור קמפיין.

list

 רשימת הקמפיינים של המפרסם.

listAssignedTargetingOptions

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

patch

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