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

کانال یک تبلیغ

Enums
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 )

مورد نیاز. ویژگی نوع ارزش کوپن برای نشان دادن نوع تبلیغی که در حال اجرا هستید. بسته به نوع ارزش کوپن انتخاب شده ، برخی از ویژگی ها مورد نیاز است .

promotionDestinations[]

enum ( DestinationEnum )

مورد نیاز. فهرست مقاصدی که تبلیغات برای آنها اعمال می شود. اگر مقصدی را با گنجاندن مقدار پشتیبانی شده در منبع داده خود مشخص نکنید، تبلیغات شما به طور پیش‌فرض در آگهی‌های خرید و فهرست‌های رایگان نمایش داده می‌شود.

ممکن است قبلاً مقادیر زیر را به عنوان مقصد محصولات خود ارسال کرده باشید: اقدامات خرید، سطوح در سراسر Google، سطوح محلی در سراسر 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 )

اختیاری. آیا این تبلیغات برای همه فروشگاه‌ها اعمال می‌شود یا فقط فروشگاه‌های مشخص شده . تبلیغات موجودی محلی در صورت عدم استفاده از فروشگاه با خطا مواجه می شوند. اگر storeApplicability روی ALL_STORES و storeCodesInclusion یا score_code_exclusion روی یک مقدار تنظیم شده باشد، خطای INVALID_ARGUMENT ایجاد می‌شود.

storeCodesInclusion[]

string

اختیاری. کدهای فروشگاهی که باید برای تبلیغات درج شوند . ویژگی‌های فیلتر ذخیره فقط زمانی اعمال می‌شود که ویژگی storeApplicability روی specific_stores تنظیم شده باشد.

کد فروشگاه (شناسه فروشگاه از نمایه کسب‌وکار شما) فروشگاه فیزیکی که محصول در آن فروخته می‌شود. برای اطلاعات بیشتر به مشخصات داده‌های موجودی محصول محلی مراجعه کنید.

storeCodesExclusion[]

string

اختیاری. کدهای فروشگاه برای حذف برای تبلیغات. ویژگی‌های فیلتر ذخیره فقط زمانی اعمال می‌شود که ویژگی storeApplicability روی specific_stores تنظیم شده باشد.

promotionUrl

string

اختیاری. نشانی وب صفحه در سایت تاجر که در آن تبلیغ نمایش داده می شود. تبلیغات موجودی محلی در صورت عدم وجود promotionUrl با خطا مواجه می شوند. از نشانی وب برای تأیید معتبر بودن تبلیغات و قابل بازخرید استفاده می شود.

کاربرد محصول

تبلیغ برای کدام محصول یا لیست محصولات اعمال می شود.

Enums
PRODUCT_APPLICABILITY_UNSPECIFIED این تبلیغات برای چه محصولاتی اعمال می شود ناشناخته است.
ALL_PRODUCTS قابل اجرا برای تمامی محصولات
SPECIFIC_PRODUCTS فقط برای یک محصول یا لیستی از محصولات قابل استفاده است.

OfferType

نوع پیشنهاد یک ترفیع

Enums
OFFER_TYPE_UNSPECIFIED نوع پیشنهاد نامشخص.
NO_CODE نوع پیشنهاد بدون کد
GENERIC_CODE نوع پیشنهاد با یک کد زمانی که offerType = GENERIC_CODE کد بازخرید عمومی برای تبلیغ مورد نیاز است.

CouponValueType

نوع ارزش کوپن یک تبلیغ.

Enums
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 نوع ارزش کوپن ارسال رایگان شبانه.
FREE_SHIPPING_TWO_DAY نوع ارزش کوپن ارسال رایگان دو روزه.

DestinationEnum

مقادیر مقصد

Enums
DESTINATION_ENUM_UNSPECIFIED مشخص نشده است.
SHOPPING_ADS تبلیغات خرید .
DISPLAY_ADS نمایش تبلیغات .
LOCAL_INVENTORY_ADS تبلیغات موجودی محلی
FREE_LISTINGS لیست های رایگان
FREE_LOCAL_LISTINGS لیست محصولات محلی رایگان
YOUTUBE_SHOPPING خرید یوتیوب .

StoreApplicability

کدهای فروشگاه یا فهرست کدهای فروشگاهی که تبلیغات برای آنها اعمال می شود. فقط برای تبلیغات موجودی محلی.

Enums
STORE_APPLICABILITY_UNSPECIFIED کدهای فروشگاهی که تبلیغات برای آنها اعمال می شود ناشناخته است.
ALL_STORES تبلیغات برای همه فروشگاه ها اعمال می شود.
SPECIFIC_STORES تبلیغات فقط برای فروشگاه های مشخص شده اعمال می شود.

وضعیت ارتقاء

وضعیت ارتقاء.

نمایندگی 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

وضعیت مقصد

وضعیت برای مقصد مشخص شده

نمایندگی JSON 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
فیلدها
reportingContext

enum ( ReportingContextEnum )

فقط خروجی نام مقصد تبلیغاتی.

status

enum ( State )

فقط خروجی وضعیت برای مقصد مشخص شده

ایالت

وضعیت فعلی تبلیغ.

Enums
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) که در آن مشکل برای پیشنهاد اعمال می شود.

شدت

شدت موضوع.

Enums
SEVERITY_UNSPECIFIED مشخص نشده است.
NOT_IMPACTED این موضوع یک هشدار است و تأثیر مستقیمی بر تبلیغات ندارد.
DEMOTED ترفیع کاهش یافته و به احتمال زیاد عملکرد محدودی در نتایج جستجو دارد
DISAPPROVED موضوع تبلیغ را تأیید نمی کند.

روش ها

get

 تبلیغ را از حساب Merchant Center شما بازیابی می کند.

insert

 یک تبلیغ برای حساب Merchant Center شما درج می کند.

list

 تبلیغات را در حساب Merchant Center شما فهرست می کند.