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 .

Если операция предотвращена, будет выброшено прерванное исключение.

Канал погашения

Канал продвижения.

Перечисления
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», «Локальные поверхности в Google». Для представления этих значений используйте FREE_LISTINGS , FREE_LOCAL_LISTINGS , LOCAL_INVENTORY_ADS . Подробнее см. в разделе «Назначение акции».

itemIdInclusion[]

string

Необязательный. Фильтр товаров по идентификатору товара для акции. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products .

brandInclusion[]

string

Необязательный. Фильтр товаров по брендам для продвижения. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products .

itemGroupIdInclusion[]

string

Необязательный. Фильтр товаров по идентификатору группы товаров для акции. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной применимости продукта [productApplicability], установлено значение «specified_products» .

productTypeInclusion[]

string

Необязательный. Фильтр товаров по типу товара для акции. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products .

itemIdExclusion[]

string

Необязательный. Фильтр товаров по исключению идентификатора товара для акции. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products .

brandExclusion[]

string

Необязательный. Фильтр продуктов по исключению брендов для продвижения. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products .

itemGroupIdExclusion[]

string

Необязательный. Фильтр товаров по идентификатору группы товаров . Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут ProductApplicability productApplicability имеет значение specific_products . исключение для продвижения.

productTypeExclusion[]

string

Необязательный. Фильтр товаров по исключению типа товара для акции. Атрибуты фильтра продуктов применяются только в том случае, если для продуктов, подходящих для рекламной акции, атрибут Product Applicability 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-адрес используется для подтверждения того, что акция действительна и ее можно активировать.

ПродуктПрименимость

На какой товар или список товаров распространяется акция.

Перечисления
PRODUCT_APPLICABILITY_UNSPECIFIED На какие товары распространяется акция, неизвестно.
ALL_PRODUCTS Применимо ко всем продуктам.
SPECIFIC_PRODUCTS Применимо только к одному продукту или списку продуктов.

Тип предложения

Тип акции.

Перечисления
OFFER_TYPE_UNSPECIFIED Неизвестный тип предложения.
NO_CODE Тип предложения без кода.
GENERIC_CODE Тип предложения с кодом. Общий код активации для акции требуется, если offerType = GENERIC_CODE .

Тип значения купона

Тип стоимости купона для акции.

Перечисления
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 Тип значения купона на двухдневную бесплатную доставку.

НазначениеEnum

Целевые значения.

Перечисления
DESTINATION_ENUM_UNSPECIFIED Не указан.
SHOPPING_ADS Товарные объявления .
DISPLAY_ADS Показ объявлений .
LOCAL_INVENTORY_ADS Реклама местного ассортимента .
FREE_LISTINGS Бесплатные списки .
FREE_LOCAL_LISTINGS Бесплатные списки местных продуктов .
YOUTUBE_SHOPPING Покупки на YouTube .

МагазинПрименимость

Коды магазинов или список кодов магазинов, на которые распространяется акция. Только для рекламы местного ассортимента.

Перечисления
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 )

Только вывод. Статус указанного пункта назначения.

Состояние

Текущее состояние продвижения.

Перечисления
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 альфа-2), в которых проблема применима к предложению.

Серьезность

Серьезность проблемы.

Перечисления
SEVERITY_UNSPECIFIED Не указан.
NOT_IMPACTED Данная проблема представляет собой предупреждение и не оказывает прямого влияния на продвижение.
DEMOTED Продвижение понижено в рейтинге и, скорее всего, будет иметь ограниченную эффективность в результатах поиска.
DISAPPROVED Проблема не одобряет продвижение.

Методы

get

 Получает промоакцию из вашего аккаунта Merchant Center.

insert

 Добавляет рекламную акцию для вашего аккаунта Merchant Center.

list

 Список промоакций в вашем аккаунте Merchant Center.