REST Resource: advertisers.lineItems

משאב: LineItem

פריט יחיד.

ייצוג JSON
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean,
  "youtubeAndPartnersSettings": {
    object (YoutubeAndPartnersSettings)
  }
}
שדות
name

string

פלט בלבד. שם המשאב של הפריט.

advertiserId

string (int64 format)

פלט בלבד. המזהה הייחודי של המפרסם שאליו שייך הפריט.

campaignId

string (int64 format)

פלט בלבד. המזהה הייחודי של הקמפיין שהפריט שייך לו.

insertionOrderId

string (int64 format)

חובה. בלתי ניתן לשינוי. המזהה הייחודי של הזמנת הקמפיין שאליה הפריט שייך.

lineItemId

string (int64 format)

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

displayName

string

חובה. השם המוצג של הפריט.

חייב להיות בקידוד UTF-8 ובגודל מקסימלי של 240 בייטים.

lineItemType

enum (LineItemType)

חובה. בלתי ניתן לשינוי. סוג הפריט.

entityStatus

enum (EntityStatus)

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

  • בשיטה lineItems.create אפשר להשתמש רק ב-ENTITY_STATUS_DRAFT. כדי להפעיל פריט, צריך להשתמש בשיטת lineItems.patch ולעדכן את הסטטוס ל-ENTITY_STATUS_ACTIVE לאחר היצירה.
  • אי אפשר להחזיר פריט לסטטוס ENTITY_STATUS_DRAFT מכל סטטוס אחר.
  • אם הזמנת הקמפיין הראשית של הפריט לא פעילה, הפריט לא יכול לנצל את התקציב שלו גם אם הסטטוס שלו הוא ENTITY_STATUS_ACTIVE.
updateTime

string (Timestamp format)

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

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

partnerCosts[]

object (PartnerCost)

עלויות השותף שמשויכות לפריט.

אם השדה הזה חסר או ריק בשיטה lineItems.create, הפריט החדש שייווצר יירש את עלויות השותף מהזמנת הקמפיין ברמת ההורה.

flight

object (LineItemFlight)

חובה. שעת ההתחלה ושעת הסיום של הטיסה של הפריט.

budget

object (LineItemBudget)

חובה. הגדרת הקצאת התקציב של הפריט.

pacing

object (Pacing)

חובה. ההגדרה של מהירות ניצול התקציב של הפריט.

frequencyCap

object (FrequencyCap)

חובה. ההגדרות של מכסת תדירות החשיפות של הפריט.

אם מקצים מכסה מוגבלת, צריך להשתמש בשדה maxImpressions באובייקט ההגדרות הזה.

partnerRevenueModel

object (PartnerRevenueModel)

חובה. הגדרת מודל ההכנסה של השותף בפריט.

conversionCounting

object (ConversionCountingConfig)

הגדרת מעקב ההמרות של הפריט.

creativeIds[]

string (int64 format)

המזהים של נכסי הקריאייטיב שמשויכים לפריט.

bidStrategy

object (BiddingStrategy)

חובה. שיטת הבידינג של הפריט.

integrationDetails

object (IntegrationDetails)

פרטי השילוב של הפריט.

targetingExpansion

object (TargetingExpansionConfig)

הגדרות הפריט של אופטימיזציית טירגוט.

ההגדרה הזו רלוונטית רק לפריטים ברשת המדיה, בסרטונים או באודיו שנעשה בהם שימוש בבידינג אוטומטי ומטרגטים באופן חיובי רשימות קהלים שעומדות בדרישות.

warningMessages[]

enum (LineItemWarningMessage)

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

mobileApp

object (MobileApp)

האפליקציה לנייד שמקודמת על ידי הפריט.

האפשרות הזו רלוונטית רק כאשר הערך של lineItemType הוא LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL או LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.

reservationType

enum (ReservationType)

פלט בלבד. סוג ההזמנה של הפריט.

excludeNewExchanges

boolean

הגדרה שקובעת אם להחריג המרות חדשות מהטירגוט האוטומטי של הפריט. כברירת מחדל, השדה הזה מוגדר כ-False.

youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

פלט בלבד. הגדרות ספציפיות לפריטים של YouTube ו-Partner.

LineItemType

סוגים אפשריים של פריט.

סוג הפריט קובע אילו הגדרות ואפשרויות יהיו רלוונטיות, למשל פורמט המודעות או אפשרויות הטירגוט.

טיפוסים בני מנייה (enum)
LINE_ITEM_TYPE_UNSPECIFIED

ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_DISPLAY_DEFAULT מודעות תמונה, HTML5, מודעות מותאמות או מודעות מדיה עשירה.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL להציג מודעות שמעודדות התקנות של אפליקציה.
LINE_ITEM_TYPE_VIDEO_DEFAULT מודעות וידאו שנמכרות על בסיס עלות לאלף חשיפות (CPM) למגוון סביבות.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL מודעות וידאו שמעודדות התקנות של אפליקציה.
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

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

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

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

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_AUDIO_DEFAULT מודעות אודיו ב-RTB שנמכרו למגוון סביבות.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP מודעות 'ישירות ללקוח' מוצגות בהזמנות קמפיין ישירות ללקוח. הסוג הזה רלוונטי רק לפריטים עם הזמנת קמפיין insertionOrderType OVER_THE_TOP.
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION

מודעות וידאו ב-YouTube שמקדמות המרות.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE

מודעות וידאו ב-YouTube (עד 15 שניות) שלא ניתן לדלג עליהן.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

מודעות וידאו ב-YouTube שמציגות סיפור ברצף מסוים באמצעות שילוב של פורמטים.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO

מודעות אודיו ב-YouTube.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH

מודעות וידאו ב-YouTube שמבצעות אופטימיזציה כדי להגיע ליותר משתמשים ייחודיים בעלות נמוכה יותר. הנכסים יכולים לכלול מודעות באמפר, מודעות וידאו In-Stream שניתן לדלג עליהן או שילוב של סוגים.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE

מודעות וידאו ב-YouTube שמוגדרות כברירת מחדל.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP

אי אפשר לדלג על מודעות וידאו ב-YouTube שמחוברות לטלוויזיות מחוברות (עד 15 שניות).

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP

מודעות וידאו ב-YouTube בטלוויזיה מחוברת שמבצעות אופטימיזציה כדי להגיע ליותר משתמשים ייחודיים בעלות נמוכה יותר. הנכסים יכולים לכלול מודעות באמפר, מודעות וידאו In-Stream שניתן לדלג עליהן או שילוב של סוגים.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP

מודעות וידאו ב-YouTube שמוגדרות כברירת מחדל לטלוויזיה מחוברת. יש לכלול רק פורמט של מודעת וידאו In-stream.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY

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

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW

מודעות וידאו ב-YouTube שמתמקדות בהגדלת מספר הצפיות בעזרת מגוון פורמטים של מודעות.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME

מודעות לרשת המדיה שמוצגות במלאי שטחי פרסום של מוצרים דיגיטליים מחוץ לבית.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME

מודעות וידאו שמוצגות במלאי שטחי פרסום של מוצרים דיגיטליים מחוץ לבית.

לא ניתן ליצור או לעדכן פריטים מהסוג הזה ואת הגדרות הטירגוט שלהם באמצעות ה-API.

LineItemFlight

הגדרות שקובעות את משך הזמן הפעיל של פריט.

ייצוג JSON
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}
שדות
flightDateType

enum (LineItemFlightDateType)

חובה. סוג תאריכי הפרסום של הפריט.

dateRange

object (DateRange)

תאריכי ההתחלה והסיום של הטיסה של הפריט. אזורי הזמן מוגדרים בהתאם לאזור הזמן של המפרסם ההורה.

  • חובה כשהערך בשדה flightDateType הוא LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. פלט רק אחרת.
  • כשיוצרים טיסה חדשה, startDate וגם endDate חייבים להיות בעתיד.
  • לטיסה קיימת עם startDate בעבר יש endDate ניתן לשינוי, אבל startDate שלא ניתן לשינוי.
  • endDate חייב להיות startDate ואילך, שניהם לפני שנת 2037.

LineItemFlightDateType

סוגים אפשריים של תאריכי טיסה של פריט.

טיפוסים בני מנייה (enum)
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED תאריכי הפרסום של הפריט עוברים בירושה מהזמנת הקמפיין הראשית.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM הפריט משתמש בתאריכי פרסום מותאמים אישית משלו.

LineItemBudget

הגדרות שקובעות את אופן הקצאת התקציב.

ייצוג JSON
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
שדות
budgetAllocationType

enum (LineItemBudgetAllocationType)

חובה. סוג הקצאת התקציב.

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

budgetUnit

enum (BudgetUnit)

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

maxAmount

string (int64 format)

סכום התקציב המקסימלי שהפריט יוציא. חייב להיות גדול מ-0.

כשהערך בשדה budgetAllocationType הוא:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC, השדה הזה לא ניתן לשינוי ומוגדר על ידי המערכת.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, אם budgetUnit הוא:
    • BUDGET_UNIT_CURRENCY, השדה הזה מייצג את סכום התקציב המקסימלי להוצאה, במיליוניות השנייה של מטבע המפרסם. לדוגמה, המספר 1500,000 מייצג 1.5 יחידות רגילות של המטבע.
    • BUDGET_UNIT_IMPRESSIONS, השדה הזה מייצג את מספר החשיפות המקסימלי שיש להציג.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, השדה הזה לא רלוונטי והמערכת תתעלם ממנו.

LineItemBudgetAllocationType

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

טיפוסים בני מנייה (enum)
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC הקצאה אוטומטית של תקציב מופעלת עבור הפריט.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED סכום תקציב מקסימלי קבוע מוקצה לפריט.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED לא חלה מגבלת תקציב על הפריט.

PartnerRevenueModel

הגדרות שקובעות את אופן החישוב של הכנסות השותף.

ייצוג JSON
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
שדות
markupType

enum (PartnerRevenueModelMarkupType)

חובה. סוג תגי העיצוב של מודל ההכנסות של השותף.

markupAmount

string (int64 format)

חובה. סכום תגי העיצוב של מודל ההכנסות של השותף. חייב להיות גדול מ-0 או שווה לו.

  • כשהערך בשדה markupType הוא PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, השדה הזה מייצג את תגי העיצוב של העלות לאלף חשיפות במיליוניות השנייה של מטבע המפרסם. לדוגמה, המספר 1500,000 מייצג 1.5 יחידות רגילות של המטבע.
  • כשהערך בשדה markupType הוא PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, השדה הזה מייצג את תגי העיצוב של אחוז עלות המדיה באלפיות השנייה. לדוגמה, 100 מייצג 0.1% (0.001 עשרונית).
  • כשהערך בשדה markupType הוא PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, השדה הזה מייצג את אחוז העלייה הכולל של עלות המדיה באלפיות השנייה. לדוגמה, 100 מייצג 0.1% (0.001 עשרונית).

PartnerRevenueModelMarkupType

סוגי תגי עיצוב אפשריים של מודל ההכנסה של השותף.

טיפוסים בני מנייה (enum)
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED ערך הסוג לא צוין או שאינו ידוע בגרסה הזו.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM חישוב הכנסות השותף על סמך עלות קבועה לאלף חשיפות (CPM).
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

מחשבים את הכנסות השותף על סמך אחוז תשלום נוסף מתוך עלות המדיה.

PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP מחשבים את הכנסות השותף על סמך אחוז תשלום נוסף מתוך עלות המדיה הכוללת, שכולל את כל העלויות ועלויות הנתונים של השותפים.

ConversionCountingConfig

הגדרות שקובעות איך ההמרות נספרות.

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

ייצוג JSON
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
שדות
postViewCountPercentageMillis

string (int64 format)

אחוז ההמרות לאחר צפייה לספירה, באלפיות שנייה (1/1,000 אחוזים). חייב להיות בין 0 ל-100,000, כולל.

לדוגמה, כדי לעקוב אחר 50% מההמרות לאחר קליק, מגדירים את הערך 50,000.

floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

הגדרות הפעילות ב-Floodlight שמשמשות למעקב אחר המרות.

מספר ההמרות שנספרות הוא הסכום של כל ההמרות שנספרו בכל מזהי הפעילות ב-Floodlight שצוינו בשדה הזה.

TrackingFloodlightActivityConfig

הגדרות שקובעות את ההתנהגות של הגדרת פעילות אחת ב-Floodlight.

ייצוג JSON
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
שדות
floodlightActivityId

string (int64 format)

חובה. המזהה של הפעילות ב-Floodlight.

postClickLookbackWindowDays

integer

חובה. מספר הימים לאחר קליק על מודעה שבמהלכם המרה יכולה להיספר. חייב להיות בין 0 ל-90, כולל.

postViewLookbackWindowDays

integer

חובה. מספר הימים לאחר צפייה במודעה, שבמהלכם ההמרה עשויה להיספר. חייב להיות בין 0 ל-90, כולל.

LineItemWarningMessage

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

טיפוסים בני מנייה (enum)
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED לא צוין או לא ידוע.
INVALID_FLIGHT_DATES לפריט הזה הוגדרו תאריכים לא חוקיים של פרק זמן של פרסום פעיל. הפריט לא יפעל.
EXPIRED תאריך הסיום של הפריט הזה חל בעבר.
PENDING_FLIGHT הפריט הזה יתחיל לפעול בעתיד.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED כל הערוצים המופעלים של שותפים נכללים במיקוד שלילי. הפריט לא יפעל.
INVALID_INVENTORY_SOURCE אין מיקוד למקורות פעילים של מלאי שטחי פרסום. הפריט לא יפעל.
APP_INVENTORY_INVALID_SITE_TARGETING המיקוד לאפליקציות ולכתובות URL של הפריט הזה לא כולל אפליקציות לנייד. סוג הפריט הזה מחייב אותך לכלול אפליקציות לנייד בטירגוט של הערוץ, רשימת האתרים או אפליקציות. הפריט לא יפעל.
APP_INVENTORY_INVALID_AUDIENCE_LISTS הפריט הזה לא מטרגט משתמשים בנייד. סוג הפריט הזה מחייב לטרגט רשימת משתמשים שכוללת משתמשים בנייד. הפריט לא יפעל.
NO_VALID_CREATIVE הפריט הזה לא מכיל קריאייטיב חוקי. הפריט לא יפעל.
PARENT_INSERTION_ORDER_PAUSED סדר ההכנסה של הפריט הזה נמצא בהשהיה. הפריט לא יפעל.
PARENT_INSERTION_ORDER_EXPIRED תאריך הסיום של הזמנת הקמפיין של הפריט הזה מוגדר בעבר. הפריט לא יפעל.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

הפריט הזה משתמש בהגדרה excludeFirstPartyAudience, שהוצאה משימוש ומתוכננת לצאת משימוש אחרי 25 במרץ 2023.

כדי להביא בחשבון את הסגירה של השדה excludeFirstPartyAudience, עליך לעדכן את השילוב של ה-API כך שיחריגו ישירות קהלים מאינטראקציה ישירה באמצעות טירגוט לפי קהל לפני 25 במרץ 2023.

MobileApp

אפליקציה לנייד שמקודמת באמצעות פריט של התקנת אפליקציה לנייד.

ייצוג JSON
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
שדות
appId

string

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

אפליקציות ל-Android מזוהות לפי מזהה החבילה שמשמש בחנות Play ב-Android, למשל com.google.android.gm.

אפליקציות ל-iOS מזוהות באמצעות מזהה אפליקציה בן תשע ספרות המשמש ב-App Store של Apple, למשל 422689480.

platform

enum (Platform)

פלט בלבד. פלטפורמת האפליקציה.

displayName

string

פלט בלבד. שם האפליקציה.

publisher

string

פלט בלבד. בעל האפליקציה.

פלטפורמה

פלטפורמות אפשריות של אפליקציות לנייד.

טיפוסים בני מנייה (enum)
PLATFORM_UNSPECIFIED הפלטפורמה לא צוינה.
IOS פלטפורמת iOS.
ANDROID פלטפורמת Android.

YoutubeAndPartnersSettings

הגדרות לפריטים של YouTube ושל Partners.

ייצוג JSON
{
  "biddingStrategy": {
    object (YoutubeAndPartnersBiddingStrategy)
  },
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementSettings": {
    object (YoutubeAndPartnersThirdPartyMeasurementSettings)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}
שדות
biddingStrategy

object (YoutubeAndPartnersBiddingStrategy)

חובה. שיטת הבידינג של הפריט YouTube ו-Partners.

viewFrequencyCap

object (FrequencyCap)

הגדרות מכסת תדירות הצפייה של הפריט.

אם מקצים מכסה מוגבלת, צריך להשתמש בשדה maxViews באובייקט ההגדרות הזה.

thirdPartyMeasurementSettings

object (YoutubeAndPartnersThirdPartyMeasurementSettings)

זה שינוי אופציונלי. הגדרות המדידה על ידי צד שלישי של הפריט.

inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

הגדרות שקובעות את מלאי שטחי הפרסום של הפריט ב-YouTube ובמלאי שלו יטרגט.

contentCategory

enum (YoutubeAndPartnersContentCategory)

סוג התוכן שבו יוצגו המודעות של YouTube ושל השותפים.

effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

פלט בלבד. קטגוריית התוכן שנכנסת לתוקף כשהפריט יוצג. כשקטגוריית התוכן מוגדרת גם בפריט וגם ברמת המפרסם, הקטגוריה המחמירה יותר תיכנס לתוקף בעת הצגת הפריט.

targetFrequency

object (TargetFrequency)

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

linkedMerchantId

string (int64 format)

המזהה של המוכר שמקושר לפריט בפיד המוצרים.

relatedVideoIds[]

string

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

leadFormId

string (int64 format)

המזהה של הטופס ליצירת לידים.

videoAdSequenceSettings

object (VideoAdSequenceSettings)

ההגדרות שקשורות ל-VideoAdSequence.

YoutubeAndPartnersThirdPartyMeasurementSettings

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

ייצוג JSON
{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}
שדות
viewabilityVendorConfigs[]

object (ThirdPartyVendorConfig)

ספקי הצד השלישי שמודדים את הניראות.

ספקי הצד השלישי הבאים רלוונטיים:

  • THIRD_PARTY_VENDOR_MOAT
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_TELEMETRY
  • THIRD_PARTY_VENDOR_MEETRICS
brandSafetyVendorConfigs[]

object (ThirdPartyVendorConfig)

ספקי צד שלישי שמודדים את בטיחות המותג.

ספקי הצד השלישי הבאים רלוונטיים:

  • THIRD_PARTY_VENDOR_ZERF
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

ספקי הצד השלישי שמודדים את היקף החשיפה.

ספקי הצד השלישי הבאים רלוונטיים:

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

ספקי צד שלישי שמודדים את התחזקות המותג.

ספקי הצד השלישי הבאים רלוונטיים:

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR

ThirdPartyVendorConfig

הגדרות שקובעות איך ספקי מדידה של צד שלישי מוגדרים.

ייצוג JSON
{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}
שדות
vendor

enum (ThirdPartyVendor)

ספק המדידה של צד שלישי.

placementId

string

המזהה שמשמש את הפלטפורמה של ספק הצד השלישי לזיהוי הפריט.

ThirdPartyVendor

ספקים שמבצעים מדידה על ידי צד שלישי.

טיפוסים בני מנייה (enum)
THIRD_PARTY_VENDOR_UNSPECIFIED ספק צד שלישי לא ידוע.
THIRD_PARTY_VENDOR_MOAT חפיר.
THIRD_PARTY_VENDOR_DOUBLE_VERIFY DoubleVerify.
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE Integral Ad Science.
THIRD_PARTY_VENDOR_COMSCORE Comscore
THIRD_PARTY_VENDOR_TELEMETRY טלמטריה.
THIRD_PARTY_VENDOR_MEETRICS Meetrics.
THIRD_PARTY_VENDOR_ZEFR ZEFR.
THIRD_PARTY_VENDOR_NIELSEN Nielsen.
THIRD_PARTY_VENDOR_KANTAR Kantar.
THIRD_PARTY_VENDOR_DYNATA Dynata.

YoutubeAndPartnersInventorySourceConfig

הגדרות שקובעות את מלאי שטחי הפרסום שקשור ל-YouTube ופריט YouTube ו-Partner יטרגט.

ייצוג JSON
{
  "includeYoutubeSearch": boolean,
  "includeYoutubeVideos": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
שדות
includeYoutubeVideos

boolean

האם לטרגט מלאי של ערוצים וסרטונים ב-YouTube ובסרטוני YouTube שמוטמעים באתרים אחרים.

includeGoogleTv

boolean

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

includeYoutubeVideoPartners

boolean

האם לטרגט מלאי שטחי פרסום באוסף של אפליקציות ואתרים של שותפים שעומדים באותם סטנדרטים להגנה על המותג של YouTube.

YoutubeAndPartnersContentCategory

קטגוריות להגנה על המותג של תוכן ב-YouTube ובתוכן של שותפים.

טיפוסים בני מנייה (enum)
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED קטגוריית התוכן לא צוינה או שאינה ידועה בגרסה הזו.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD קטגוריה שכוללת מגוון רחב של תכנים שמתאימים לרוב המותגים. התוכן מבוסס על ההנחיות של YouTube ליצירת תוכן ידידותי למפרסמים.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED קטגוריה שכוללת את כל התכנים ב-YouTube ואצל שותפי הווידאו שעומדים בסטנדרטים למונטיזציה.
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED קטגוריה שכוללת מגוון מצומצם של תכנים, שעומדים בדרישות נוקשות יותר, במיוחד בנוגע לשפה לא הולמת וברמיזות מיניות.

TargetFrequency

הגדרה שקובעת את מספר הפעמים הממוצע שהמודעות יוצגו לאותו משתמש במהלך פרק זמן מסוים.

ייצוג JSON
{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}
שדות
targetCount

string (int64 format)

מספר הפעמים הממוצע שהמודעות יוצגו לאותו אדם בתקופת הזמן שנקבעה על ידי timeUnit ו-timeUnitCount.

timeUnit

enum (TimeUnit)

יחידת הזמן שבה תחול תדירות הטירגוט.

יחידת הזמן הבאה רלוונטית:

  • TIME_UNIT_WEEKS
timeUnitCount

integer

המספר של timeUnit שתדירות הטירגוט תהיה בתוקף.

ההגבלות הבאות חלות על הערך של timeUnit:

  • TIME_UNIT_WEEKS – חייב להיות 1

VideoAdSequenceSettings

הגדרות שקשורות ל-VideoAdSequence.

ייצוג JSON
{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}
שדות
minimumDuration

enum (VideoAdSequenceMinimumDuration)

מרווח הזמן המינימלי לפני שאותו משתמש יראה שוב את הרצף הזה.

steps[]

object (VideoAdSequenceStep)

השלבים שבהם הרצף מורכב.

VideoAdSequenceMinimumDuration

enum של מרווח זמן מינימלי אפשרי לפני שאותו משתמש יראה שוב את VideoAdSequence.

טיפוסים בני מנייה (enum)
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED לא צוין או לא ידוע.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 ימים.
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 ימים.

VideoAdSequenceStep

הפרטים של שלב יחיד ב-VideoAdSequence.

ייצוג JSON
{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}
שדות
stepId

string (int64 format)

מזהה השלב.

adGroupId

string (int64 format)

המזהה של קבוצת המודעות המתאימה לשלב.

previousStepId

string (int64 format)

המזהה של השלב הקודם. לשלב הראשון לא יש את השלב הקודם.

interactionType

enum (InteractionType)

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

InteractionType

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

טיפוסים בני מנייה (enum)
INTERACTION_TYPE_UNSPECIFIED לא צוין או לא ידוע
INTERACTION_TYPE_PAID_VIEW צפייה בתשלום.
INTERACTION_TYPE_SKIP הצופה דילג עליה.
INTERACTION_TYPE_IMPRESSION חשיפה (צפייה) של מודעה.
INTERACTION_TYPE_ENGAGED_IMPRESSION חשיפה של מודעה שהצופה לא דילג עליה מיד, אבל גם לא הגיעה לאירוע לחיוב.

שיטות

bulkEditAssignedTargetingOptions

עריכות בכמות גדולה של אפשרויות טירגוט בכמה פריטים.

bulkListAssignedTargetingOptions

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

bulkUpdate

מעדכן מספר פריטים.

create

יצירת פריט חדש.

delete

מוחק פריט.

duplicate

שכפול פריט.

generateDefault

יצירת פריט חדש עם הגדרות (כולל טירגוט) שעברו בירושה מהזמנת הקמפיין וENTITY_STATUS_DRAFT entity_status.

get

מקבל פריט.

list

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

patch

עדכון פריט קיים.