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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

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

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

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

טיפוסים בני מנייה (enums)
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.

טיפוסים בני מנייה (enums)
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

 מעדכנות קמפיין קיים.