REST Resource: accounts.promotions

משאב: קידום מכירות

מייצג מבצע. מידע נוסף זמין במאמרים הבאים.

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

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

ייצוג JSON 
{
  "name": string,
  "promotionId": string,
  "contentLanguage": string,
  "targetCountry": string,
  "redemptionChannel": [
    enum (RedemptionChannel)
  ],
  "dataSource": string,
  "attributes": {
    object (Attributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "promotionStatus": {
    object (PromotionStatus)
  },
  "versionNumber": string
}
שדות
name

string

מזהה. שם הקידום. פורמט: accounts/{account}/promotions/{promotion}
promotionId

string

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

string

חובה. קוד שפה בן שתי אותיות לפי תקן ISO 639-1 שמשויך למבצע.

מבצעים זמינים רק בשפות נבחרות.
targetCountry

string

חובה. מדינת היעד שמשמשת כחלק מהמזהה הייחודי. מיוצג כקוד של אזור CLDR.

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

enum (RedemptionChannel)

חובה. ערוץ מימוש של המבצע. צריך להזין לפחות ערוץ אחד.
dataSource

string

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

object (Attributes)

זה שינוי אופציונלי. רשימה של מאפייני מבצע.
customAttributes[]

object (CustomAttribute)

זה שינוי אופציונלי. רשימה של מאפיינים מותאמים אישית (שהמוכר סיפק). אפשר להשתמש בו גם כדי לשלוח כל מאפיין של מפרט הנתונים בגרסה הכללית (לדוגמה, { "name": "size type", "value": "regular" }). האפשרות הזו שימושית לשליחת מאפיינים שלא נחשפו במפורש על ידי ה-API.
promotionStatus

object (PromotionStatus)

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

string (int64 format)

זה שינוי אופציונלי. מייצג את הגרסה הקיימת (העדכניות) של המבצע, שניתן להשתמש בה כדי לשמור על הסדר הנכון כשמבצעים כמה עדכונים בו-זמנית.

אם המדיניות מוגדרת, המערכת מונעת את ההוספה של פריטים כשמספר הגרסה נמוך ממספר הגרסה הנוכחי של המבצע הקיים. אפשר לבצע הוספה מחדש (לדוגמה, רענון המבצע אחרי 30 ימים) עם הערך הנוכחי של versionNumber.

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

RedemptionChannel

ערוץ של קידום מכירות.

טיפוסים בני מנייה (enum)
REDEMPTION_CHANNEL_UNSPECIFIED מציין שהערוץ לא צוין.
IN_STORE מציין שהערוץ נמצא בחנות. זה זהה לערוץ אחד (local) שמשמש את products.
ONLINE מציין שהערוץ במצב אונליין.

מאפיינים

מאפיינים.

ייצוג JSON 
{
  "productApplicability": enum (ProductApplicability),
  "offerType": enum (OfferType),
  "genericRedemptionCode": string,
  "longTitle": string,
  "couponValueType": enum (CouponValueType),
  "promotionDestinations": [
    enum (DestinationEnum)
  ],
  "itemIdInclusion": [
    string
  ],
  "brandInclusion": [
    string
  ],
  "itemGroupIdInclusion": [
    string
  ],
  "productTypeInclusion": [
    string
  ],
  "itemIdExclusion": [
    string
  ],
  "brandExclusion": [
    string
  ],
  "itemGroupIdExclusion": [
    string
  ],
  "productTypeExclusion": [
    string
  ],
  "minimumPurchaseAmount": {
    object (Price)
  },
  "minimumPurchaseQuantity": string,
  "limitQuantity": string,
  "limitValue": {
    object (Price)
  },
  "percentOff": string,
  "moneyOffAmount": {
    object (Price)
  },
  "getThisQuantityDiscounted": string,
  "freeGiftValue": {
    object (Price)
  },
  "freeGiftDescription": string,
  "freeGiftItemId": string,
  "promotionEffectiveTimePeriod": {
    object (Interval)
  },
  "promotionDisplayTimePeriod": {
    object (Interval)
  },
  "storeApplicability": enum (StoreApplicability),
  "storeCodesInclusion": [
    string
  ],
  "storeCodesExclusion": [
    string
  ],
  "promotionUrl": string
}
שדות
productApplicability

enum (ProductApplicability)

חובה. המבצע חל על כל המוצרים או על רק מוצרים ספציפיים.
offerType

enum (OfferType)

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

string

זה שינוי אופציונלי. קוד מימוש גנרי של מבצע לשימוש עם השדה offerType, והוא חייב לעמוד בדרישות המינימליות.
longTitle

string

חובה. שם ארוך למבצע.
couponValueType

enum (CouponValueType)

חובה. המאפיין coupon value type משמש לציון סוג המבצע שאתם מציעים. חובה לשלוח כמה מאפיינים בהתאם לסוג ערך השובר שנבחר.
promotionDestinations[]

enum (DestinationEnum)

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

יכול להיות ששלחתם בעבר את הערכים הבאים בתור יעדים למוצרים שלכם: Shopping Actions, Surfaces across Google, Local surfaces across Google. כדי לייצג את הערכים האלה, צריך להשתמש בפונקציה FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. פרטים נוספים זמינים במאמר יעד המבצע.
itemIdInclusion[]

string

זה שינוי אופציונלי. סינון המוצרים לפי מזהה הפריט של המבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
brandInclusion[]

string

זה שינוי אופציונלי. סינון המוצרים לפי המותג של המבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
itemGroupIdInclusion[]

string

זה שינוי אופציונלי. סינון המוצרים לפי מזהה קבוצת הפריטים של המבצע. המאפיינים של סינון המוצרים רלוונטיים רק כאשר הערך של מאפיין המוצרים שעליהם חל המבצע [productApplicability] הוא specific_products.
productTypeInclusion[]

string

זה שינוי אופציונלי. סינון המוצרים לפי סוג המוצר שבמבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
itemIdExclusion[]

string

זה שינוי אופציונלי. סינון מוצרים לפי החרגה של מזהה פריט במבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
brandExclusion[]

string

זה שינוי אופציונלי. סינון מוצרים לפי החרגת מותגים במבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
itemGroupIdExclusion[]

string

זה שינוי אופציונלי. סינון מוצרים לפי מזהה קבוצת הפריטים. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products. החרגה של המבצע.
productTypeExclusion[]

string

זה שינוי אופציונלי. סינון מוצרים לפי החרגה של סוג המוצר במבצע. המאפיינים של סינון המוצרים רלוונטיים רק כשמאפיין המוצרים שעליהם חל המבצע productApplicability מוגדר כ-specific_products.
minimumPurchaseAmount

object (Price)

זה שינוי אופציונלי. סכום רכישה מינימלי למבצע.
minimumPurchaseQuantity

string (int64 format)

זה שינוי אופציונלי. כמות רכישה מינימלית במבצע.
limitQuantity

string (int64 format)

זה שינוי אופציונלי. כמות מקסימלית של רכישה במבצע.
limitValue

object (Price)

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

string (int64 format)

זה שינוי אופציונלי. ההנחה באחוזים שמוצעת במבצע.
moneyOffAmount

object (Price)

זה שינוי אופציונלי. סכום ההנחה הכספית שמוצע במבצע.
getThisQuantityDiscounted

string (int64 format)

זה שינוי אופציונלי. מספר הפריטים בהנחה במבצע. המאפיין מוגדר כאשר couponValueType שווה ל-buy_m_get_n_money_off או ל-buy_m_get_n_percent_off.
freeGiftValue

object (Price)

זה שינוי אופציונלי. שווי מתנה במסגרת המבצע.
freeGiftDescription

string

זה שינוי אופציונלי. תיאור המתנה במסגרת המבצע.
freeGiftItemId

string

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

object (Interval)

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

object (Interval)

זה שינוי אופציונלי. TimePeriod ייצוג של תאריכי הצגת המבצע. המאפיין הזה מציין את התאריך והשעה שבהם המבצע יהיה זמין ב-Google.com ובמודעות שופינג. אם לא תציינו את תקופת הזמן להצגת המבצע promotionDisplayTimePeriod, תקופת התוקף של המבצע promotionEffectiveTimePeriod תקבע את התאריך והשעה שבהם המבצע יהיה פעיל ב-Google.com ובמודעות שופינג.
storeApplicability

enum (StoreApplicability)

זה שינוי אופציונלי. אם המבצע חל על כל החנויות, או רק על חנויות ספציפיות. אם לא ציינת את המוצרים שעליהם חל המבצע, תופיע הודעת שגיאה לגבי מבצעים במודעות מלאי של חנויות מקומיות. שגיאה מסוג INVALID_ARGUMENT תיזרק אם storeApplicability מוגדר לערך ALL_STORES ו-storeCodesInclusion או score_code_exclusion מוגדר כערך.
storeCodesInclusion[]

string

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

קוד החנות (מזהה החנות שרשום בפרופיל העסק) של החנות הפיזית שבה המוצר נמכר. מידע נוסף זמין במפרט נתוני מלאי המוצרים בחנויות המקומיות.
storeCodesExclusion[]

string

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

string

זה שינוי אופציונלי. כתובת ה-URL של הדף באתר של המוכר שבו מוצג המבצע. אם לא ציינת promotionUrl, מבצעים שקשורים למודעות מלאי של חנויות מקומיות יציגו הודעת שגיאה. כתובת ה-URL משמשת כדי לאשר שהמבצע תקף ואפשר לממש אותו.

ProductApplicability

המוצר או רשימת המוצרים שעליהם חל המבצע.

טיפוסים בני מנייה (enum)
PRODUCT_APPLICABILITY_UNSPECIFIED המוצרים שעליהם חל המבצע לא ידועים.
ALL_PRODUCTS רלוונטי לכל המוצרים.
SPECIFIC_PRODUCTS רלוונטי רק למוצר אחד או לרשימת מוצרים אחת.

OfferType

סוג מבצע של מבצע.

טיפוסים בני מנייה (enum)
OFFER_TYPE_UNSPECIFIED סוג ההצעה לא ידוע.
NO_CODE סוג המבצע ללא קוד.
GENERIC_CODE סוג המבצע עם קוד. יש לציין קוד מימוש גנרי למבצע כאשר offerType = GENERIC_CODE.

CouponValueType

סוג ערך שובר של מבצע.

טיפוסים בני מנייה (enum)
COUPON_VALUE_TYPE_UNSPECIFIED מציין שסוג ערך השובר לא צוין.
MONEY_OFF סוג ערך שובר הנחה.
PERCENT_OFF סוג ערך שובר באחוזים.
BUY_M_GET_N_MONEY_OFF בקניית כמות M, מקבלים הנחה של N כסף על סוג ערך השובר. יש לכלול את minimumPurchaseQuantity ואת getThisQuantityDiscounted. חובה לכלול גם את moneyOffAmount.
BUY_M_GET_N_PERCENT_OFF בקניית כמות M, מקבלים הנחה של N אחוזים בערך שובר. יש לכלול את minimumPurchaseQuantity ואת getThisQuantityDiscounted. חובה לכלול גם את percent_off_percentage.
BUY_M_GET_MONEY_OFF קונים כמות M ומקבלים הנחה. minimumPurchaseQuantity וגם moneyOffAmount צריכים להופיע.
BUY_M_GET_PERCENT_OFF קונים כמות M ומקבלים הנחה. minimumPurchaseQuantity וגם percent_off_percentage צריכים להופיע.
FREE_GIFT מתנה עם תיאור בלבד.
FREE_GIFT_WITH_VALUE מתנה עם ערך כספי.
FREE_GIFT_WITH_ITEM_ID מתנה עם מזהה פריט.
FREE_SHIPPING_STANDARD סוג ערך רגיל של שובר משלוח חינם.
FREE_SHIPPING_OVERNIGHT סוג הערך של שובר למשלוח חינם תוך 24 שעות.
FREE_SHIPPING_TWO_DAY סוג הערך של שובר למשלוח חינם תוך יומיים בלבד.

DestinationEnum

ערכי יעדים.

טיפוסים בני מנייה (enum)
DESTINATION_ENUM_UNSPECIFIED לא צוין.
SHOPPING_ADS מודעות שופינג.
DISPLAY_ADS מודעות לרשת המדיה.
LOCAL_INVENTORY_ADS מודעות מלאי של חנויות מקומיות.
FREE_LISTINGS כרטיסי מוצר חינמיים
FREE_LOCAL_LISTINGS כרטיסים חינמיים למוצרים מקומיים.
YOUTUBE_SHOPPING YouTube שופינג.

StoreApplicability

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

טיפוסים בני מנייה (enum)
STORE_APPLICABILITY_UNSPECIFIED קודי החנויות שעליהם חל המבצע לא ידועים.
ALL_STORES המבצע תקף לכל החנויות.
SPECIFIC_STORES המבצע תקף רק לחנויות שצוינו.

PromotionStatus

הסטטוס של קידום המכירות.

ייצוג JSON 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string
}
שדות
destinationStatuses[]

object (DestinationStatus)

פלט בלבד. היעדים שאליהם מיועד המבצע.
itemLevelIssues[]

object (ItemLevelIssue)

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

string (Timestamp format)

פלט בלבד. התאריך שבו נוצר קידום המכירות בפורמט ISO 8601: תאריך, שעה וקיזוז. לדוגמה: 2020-01-02T09:00:00+01:00 או 2020-01-02T09:00:00Z
lastUpdateDate

string (Timestamp format)

פלט בלבד. התאריך שבו סטטוס המבצע עודכן לאחרונה בפורמט ISO 8601: תאריך, שעה וקיזוז. לדוגמה: 2020-01-02T09:00:00+01:00 או 2020-01-02T09:00:00Z

DestinationStatus

הסטטוס של היעד שצוין.

ייצוג JSON 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
שדות
reportingContext

enum (ReportingContextEnum)

פלט בלבד. השם של יעד המבצע.
status

enum (State)

פלט בלבד. הסטטוס של היעד שצוין.

ארץ

המצב הנוכחי של המבצע.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב קידום לא ידוע.
IN_REVIEW קידום הסרטון נמצא בבדיקה.
REJECTED קידום המכירות נדחה.
LIVE המבצע אושר ופעיל.
STOPPED המוכר הפסיק את המבצע.
EXPIRED קידום המכירות כבר לא פעיל.
PENDING המבצע לא הופסק וכל הביקורות מאושרות, אבל תאריך הפעילות חל בעתיד.

ItemLevelIssue

הבעיה שמשויכת למבצע.

ייצוג JSON 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
שדות
code

string

פלט בלבד. קוד השגיאה של הבעיה.
severity

enum (Severity)

פלט בלבד. איך הבעיה הזו משפיעה על הצגת המבצע.
resolution

string

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

string

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

enum (ReportingContextEnum)

פלט בלבד. היעד שאליו קשורה הבעיה.
description

string

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

string

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

string

פלט בלבד. כתובת ה-URL של דף אינטרנט שעוזר לפתור את הבעיה.
applicableCountries[]

string

פלט בלבד. רשימת קודי מדינות (ISO 3166-1 alpha-2) שבהם הבעיה רלוונטית למוצר.

מידת החומרה

חומרת הבעיה.

טיפוסים בני מנייה (enum)
SEVERITY_UNSPECIFIED לא צוין.
NOT_IMPACTED הבעיה הזו מייצגת אזהרה ואין לה השפעה ישירה על המבצע.
DEMOTED קידום המכירות יורד, וסביר להניח שהביצועים שלו יהיו מוגבלים בתוצאות החיפוש
DISAPPROVED בגלל בעיה המבצע נפסל.

שיטות

get

 מאחזר את פרטי המבצע מחשבון Merchant Center.

insert

 מוסיף מבצע לחשבון Merchant Center שלכם.

list

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