Package google.shopping.merchant.promotions.v1beta

Индекс

АкцииСервис

Сервис для управления продвижением товаров.

Получить продвижение

rpc GetPromotion( GetPromotionRequest ) returns ( Promotion )

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

После вставки или обновления рекламной акции может пройти несколько минут, прежде чем обновленную рекламную акцию можно будет получить.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

ВставитьПродвижение

rpc InsertPromotion( InsertPromotionRequest ) returns ( Promotion )

Добавляет рекламную акцию для вашего аккаунта Merchant Center. Если акция уже существует, вместо этого она обновляется.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

СписокАкции

rpc ListPromotions( ListPromotionsRequest ) returns ( ListPromotionsResponse )

Список промоакций в вашем аккаунте Merchant Center. Ответ может содержать меньше элементов, чем указано в pageSize . Положитесь на pageToken , чтобы определить, есть ли еще элементы, которые нужно запросить.

После вставки или обновления промоакции может пройти несколько минут, прежде чем обновленную обработанную акцию можно будет получить.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/content

Для получения дополнительной информации см.OAuth 2.0 Overview .

Атрибуты

Атрибуты.

Поля
product_ applicability

ProductApplicability

Необходимый. Применимость акции ко всем продуктам или только к определенным продуктам .

offer_ type

OfferType

Необходимый. Тип акции. Используйте этот атрибут, чтобы указать, нужен ли клиентам код купона для активации вашей акции.

generic_ redemption_ code

string

Необязательный. Общий код активации для акции. Используется с полем offerType и должно соответствовать минимальным требованиям .

long_ title

string

Необходимый. Длинное название акции.

coupon_ value_ type

CouponValueType

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

promotion_ destinations[]

DestinationEnum

Необходимый. Список направлений, на которые распространяется акция. Если вы не укажете пункт назначения, включив поддерживаемое значение в источник данных, ваше продвижение будет по умолчанию отображаться в товарных объявлениях и бесплатных предложениях.

Возможно, вы ранее указали следующие значения в качестве мест назначения для своих продуктов: «Покупки в Google», «Поверхности в Google», «Локальные поверхности в Google». Для представления этих значений используйте FREE_LISTINGS , FREE_LOCAL_LISTINGS , LOCAL_INVENTORY_ADS . Подробнее см. в разделе «Назначение акции».

item_ id_ inclusion[]

string

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

brand_ inclusion[]

string

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

item_ group_ id_ inclusion[]

string

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

product_ type_ inclusion[]

string

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

item_ id_ exclusion[]

string

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

brand_ exclusion[]

string

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

item_ group_ id_ exclusion[]

string

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

product_ type_ exclusion[]

string

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

minimum_ purchase_ amount

Price

Необязательный. Минимальная сумма покупки по акции.

minimum_ purchase_ quantity

int64

Необязательный. Минимальный объем закупки по акции.

limit_ quantity

int64

Необязательный. Максимальный объем покупки по акции.

limit_ value

Price

Необязательный. Максимальная цена товара по акции.

percent_ off

int64

Необязательный. Процентная скидка, предлагаемая в рамках акции.

money_ off_ amount

Price

Необязательный. Сумма денежной скидки, предлагаемая в рамках акции.

get_ this_ quantity_ discounted

int64

Необязательный. Количество товаров со скидкой по акции. Атрибут устанавливается, когда couponValueType равен buy_m_get_n_money_off или buy_m_get_n_percent_off .

free_ gift_ value

Price

Необязательный. Стоимость бесплатного подарка по акции.

free_ gift_ description

string

Необязательный. Бесплатное описание подарка по акции.

free_ gift_ item_ id

string

Необязательный. Бесплатный идентификатор подарочного товара по акции.

promotion_ effective_ time_ period

Interval

Необходимый. TimePeriod представление дат вступления в силу промоакции. Этот атрибут указывает, что акция может быть протестирована в вашем интернет-магазине в течение этого периода времени.

promotion_ display_ time_ period

Interval

Необязательный. Представление TimePeriod дат отображения рекламной акции. Этот атрибут определяет дату и период времени, когда рекламная акция будет доступна на Google.com и в товарных объявлениях. Если период времени показа рекламной акции в атрибуте promotion_display_time_period не указан, период действия рекламной акции, promotion_effective_time_period определяет дату и период времени, когда рекламная акция будет доступна на Google.com и в товарных объявлениях.

store_ applicability

StoreApplicability

Необязательный. Распространяется ли акция на все магазины или только на определенные магазины . Реклама местного ассортимента выдает ошибку, если не указана применимость к магазину. Ошибка INVALID_ARGUMENT выдается, если для store_applicability установлено значение ALL_STORES , а store_codes_inclusion или score_code_exclusion установлено значение.

store_ codes_ inclusion[]

string

Необязательный. Коды магазинов для участия в акции. Атрибуты фильтра магазина применяются только в том случае, если для атрибута store_applicability установлено значение specific_stores .

Код магазина (идентификатор магазина из профиля вашей компании) физического магазина, в котором продается товар. Дополнительную информацию см. в спецификации данных о местном ассортименте .

store_ codes_ exclusion[]

string

Необязательный. Коды магазинов, которые следует исключить из акции. Атрибуты фильтра магазина применяются только в том случае, если для атрибута store_applicability установлено значение specific_stores .

promotion_ url

string

Необязательный. URL-адрес страницы сайта продавца, на которой отображается промоакция. При продвижении рекламы местного ассортимента выдается ошибка, если promotion_url не указан. URL-адрес используется для подтверждения того, что акция действительна и ее можно активировать.

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

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

Перечисления
COUPON_VALUE_TYPE_UNSPECIFIED Указывает, что тип значения купона не указан.
MONEY_OFF Тип значения купона на скидку.
PERCENT_OFF Тип значения процентной скидки купона.
BUY_M_GET_N_MONEY_OFF Купите количество M, получите N денег со скидки по типу стоимости купона. minimum_purchase_quantity и get_this_quantity_discounted должны присутствовать. money_off_amount также должен присутствовать.
BUY_M_GET_N_PERCENT_OFF Купите количество M, получите скидку N процентов на тип стоимости купона. minimum_purchase_quantity и get_this_quantity_discounted должны присутствовать. percent_off_percentage также должен присутствовать.
BUY_M_GET_MONEY_OFF Купите количество M, получите скидку. minimum_purchase_quantity и money_off_amount должны присутствовать.
BUY_M_GET_PERCENT_OFF Купите количество M, получите скидку. minimum_purchase_quantity и percent_off_percentage должны присутствовать.
FREE_GIFT Бесплатный подарок только с описанием.
FREE_GIFT_WITH_VALUE Бесплатный подарок с денежной оценкой.
FREE_GIFT_WITH_ITEM_ID Бесплатный подарок с указанием идентификатора товара.
FREE_SHIPPING_STANDARD Тип значения стандартного купона на бесплатную доставку. Доступно только для онлайн-акций.
FREE_SHIPPING_OVERNIGHT Тип значения купона на бесплатную доставку на ночь. Доступно только для онлайн-акций.
FREE_SHIPPING_TWO_DAY Тип значения купона на двухдневную бесплатную доставку. Доступно только для онлайн-акций.

Получить запрос на продвижение

Сообщение запроса для метода GetPromotion .

Поля
name

string

Необходимый. Название рекламной акции, которую нужно получить. Формат: accounts/{account}/promotions/{promotions}

ВставкаPromotionRequest

Сообщение запроса для метода InsertPromotion .

Поля
parent

string

Необходимый. Аккаунт, в который будет добавлена ​​акция. Формат: аккаунты/{аккаунт}

promotion

Promotion

Необходимый. Продвижение для вставки.

data_ source

string

Необходимый. Источник данных формата продвижения : accounts/{account}/dataSources/{datasource} .

СписокАкцииЗапрос

Сообщение запроса для метода ListPromotions .

Поля
parent

string

Необходимый. Аккаунт, для которого нужно перечислить обработанные рекламные акции. Формат: accounts/{account}

page_ size

int32

Только вывод. Максимальное количество акций для возврата. Служба может возвращать меньшее значение, чем это значение. Максимальное значение — 250; значения выше 250 будут сокращены до 250. Если не указано, будет возвращено максимальное количество рекламных акций.

page_ token

string

Только вывод. Токен страницы, полученный в результате предыдущего вызова ListPromotions . Предоставьте это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставляемые ListPromotions должны соответствовать вызову, который предоставил токен страницы.

Список рекламных акцийОтвет

Ответное сообщение для метода ListPromotions .

Поля
promotions[]

Promotion

Обработанные акции с указанного аккаунта.

next_ page_ token

string

Токен, который можно отправить как page_token для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

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

Тип акции.

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

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

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

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

Повышение

Представляет собой продвижение по службе. Более подробную информацию смотрите в следующих статьях.

Необходимые входные атрибуты промоакции для прохождения проверок достоверности данных в основном определены ниже:

После вставки и обновления входных данных о промо-акции может пройти несколько минут, прежде чем можно будет получить окончательную рекламную акцию.

Поля
name

string

Идентификатор. Название акции. Формат: accounts/{account}/promotions/{promotion}

promotion_ id

string

Необходимый. Пользователь предоставил идентификатор акции, чтобы однозначно идентифицировать ее. Соблюдайте минимальные требования , чтобы избежать отклонения рекламных акций.

content_ language

string

Необходимый. Двухбуквенный языковой код ISO 639-1 для рекламной акции.

Акции доступны только для выбранных языков .

target_ country

string

Необходимый. Целевая страна используется как часть уникального идентификатора. Представлен в виде кода территории CLDR .

Промоакции доступны только в некоторых странах. Бесплатные предложения и товарная реклама, реклама местного ассортимента.

redemption_ channel[]

RedemptionChannel

Необходимый. Канал выкупа для продвижения. Требуется хотя бы один канал.

data_ source

string

Только вывод. Основной источник данных промоакции.

attributes

Attributes

Необязательный. Список атрибутов продвижения.

custom_ attributes[]

CustomAttribute

Необязательный. Список пользовательских атрибутов (предоставленных продавцом). Его также можно использовать для отправки любого атрибута спецификации данных в его общей форме (например, { "name": "size type", "value": "regular" } ). Это полезно для отправки атрибутов, которые API явно не предоставляет.

promotion_ status

PromotionStatus

Только вывод. Статус акции , вопросы проверки данных, то есть информация о акции вычисляется асинхронно.

version_ number

int64

Необязательный. Представляет существующую версию (свежесть) акции, которую можно использовать для сохранения правильного порядка при одновременном выполнении нескольких обновлений.

Если этот параметр установлен, вставка предотвращается, если номер версии меньше текущего номера версии существующего рекламного мероприятия. Повторную вставку (например, обновление акции через 30 дней) можно выполнить с текущим version_number .

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

Статус продвижения

Статус акции.

Поля
destination_ statuses[]

DestinationStatus

Только вывод. Целевые направления продвижения.

item_ level_ issues[]

ItemLevelIssue

Только вывод. Перечень вопросов, связанных с продвижением.

creation_ date

Timestamp

Только вывод. Дата создания рекламного мероприятия в формате ISO 8601 : дата, время и смещение, например 2020-01-02T09:00:00+01:00 или 2020-01-02T09:00:00Z

last_ update_ date

Timestamp

Только вывод. Дата последнего обновления статуса продвижения в формате ISO 8601 : дата, время и смещение, например 2020-01-02T09:00:00+01:00 или 2020-01-02T09:00:00Z

Статус назначения

Статус указанного пункта назначения.

Поля
reporting_ context

ReportingContextEnum

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

status

State

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

Состояние

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

Перечисления
STATE_UNSPECIFIED Неизвестный статус продвижения.
IN_REVIEW Акция находится на рассмотрении.
REJECTED Продвижение отклонено.
LIVE Акция одобрена и активна.
STOPPED Акция остановлена ​​продавцом.
EXPIRED Акция больше не активна.
PENDING Акция не остановлена, все отзывы одобрены, но дата активации находится в будущем.

ItemLevelIssue

Вопрос связан с продвижением.

Поля
code

string

Только вывод. Код ошибки проблемы.

severity

Severity

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

resolution

string

Только вывод. Может ли проблема быть решена продавцом.

attribute

string

Только вывод. Имя атрибута, если проблема вызвана одним атрибутом.

reporting_ context

ReportingContextEnum

Только вывод. Пункт назначения, к которому относится проблема.

description

string

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

detail

string

Только вывод. Подробное описание проблемы на английском языке.

documentation

string

Только вывод. URL-адрес веб-страницы, которая поможет решить эту проблему.

applicable_ countries[]

string

Только вывод. Список кодов стран (ISO 3166-1 альфа-2), в которых проблема применима к предложению.

Серьезность

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

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

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

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

Перечисления
REDEMPTION_CHANNEL_UNSPECIFIED Указывает, что канал не указан.
IN_STORE Указывает, что канал доступен. Это то же самое, что и local канал, используемый для products .
ONLINE Указывает, что канал онлайн.

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

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

Перечисления
STORE_APPLICABILITY_UNSPECIFIED На какие коды магазинов распространяется акция, неизвестно.
ALL_STORES Акция распространяется на все магазины.
SPECIFIC_STORES Акция распространяется только на указанные магазины.