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 סוג ערך השובר: הנחה של N בקניית M. יש לכלול את השדות minimumPurchaseQuantity ו-getThisQuantityDiscounted. צריך לכלול גם את השדה moneyOffAmount.
BUY_M_GET_N_PERCENT_OFF הנחה של N אחוזים בקניית כמות M. יש לכלול את השדות 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 Shopping.
YOUTUBE_SHOPPING_CHECKOUT תשלום ב-YouTube שופינג.
YOUTUBE_AFFILIATE שותף עצמאי של YouTube.
FREE_VEHICLE_LISTINGS כרטיסי מוצר חינמיים לפרסום רכבים.
VEHICLE_ADS מודעות למכירת רכב.
CLOUD_RETAIL קמעונאות בענן.
LOCAL_CLOUD_RETAIL קמעונאות מקומית בענן.

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 הבעיה גורמת לדחיית המבצע.

Methods

get

 אחזור המבצע מחשבון Merchant Center.

insert

 הוספת קידום מכירות לחשבון Merchant Center.

list

 רשימה של המבצעים בחשבון Merchant Center.