Package google.shopping.merchant.promotions.v1beta

Índice

PromotionsService

Servicio para administrar promociones de productos.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Recupera la promoción de su cuenta de Merchant Center.

Después de insertar o actualizar una entrada de promoción, es posible que debas esperar varios minutos para poder recuperar la promoción actualizada.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Inserta una promoción para tu cuenta de Merchant Center. Si la promoción ya existe, se actualizará.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Muestra las promociones de tu cuenta de Merchant Center. Es posible que la respuesta contenga menos elementos que los especificados por pageSize. Usa pageToken para determinar si hay más elementos que se pueden solicitar.

Después de insertar o actualizar una promoción, pueden pasar varios minutos hasta que se pueda recuperar la promoción procesada y actualizada.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

Atributos

Atributos

Campos
product_applicability

ProductApplicability

Obligatorio. La aplicabilidad de la promoción a todos los productos o solo a productos específicos.
offer_type

OfferType

Obligatorio. Es el tipo de promoción. Usa este atributo para indicar si los clientes necesitan o no un código de cupón para canjear tu promoción.
generic_redemption_code

string

Opcional. Código de canje genérico de la promoción. Se debe usar con el campo offerType y debe cumplir con los requisitos mínimos.
long_title

string

Obligatorio. Es el título largo de la promoción.
coupon_value_type

CouponValueType

Obligatorio. El atributo coupon value type para indicar el tipo de promoción que publica Según el tipo de valor del cupón seleccionado, algunos atributos son obligatorios.
promotion_destinations[]

DestinationEnum

Obligatorio. Es la lista de destinos a los que se aplica la promoción. Si no especificas un destino con un valor admitido en tu fuente de datos, la promoción se mostrará de forma predeterminada en los anuncios de Shopping y las fichas gratuitas.

Es posible que, anteriormente, hayas enviado los siguientes valores como destinos para tus productos: Acciones de Shopping, Plataformas de Google o Plataformas locales de Google. Para representar estos valores, usa FREE_LISTINGS, FREE_LOCAL_LISTINGS y LOCAL_INVENTORY_ADS. Para obtener más detalles, consulta Destino de la promoción.
item_id_inclusion[]

string

Opcional. Filtro de producto por ID de artículo para la promoción. Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
brand_inclusion[]

string

Opcional. Filtro de productos por marca para la promoción Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
item_group_id_inclusion[]

string

Opcional. Filtro de productos por ID de grupo de artículos para la promoción Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto apto para la promoción [product_applicability] está configurado en specific_products.
product_type_inclusion[]

string

Opcional. Filtro de productos por tipo de producto para la promoción. Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
item_id_exclusion[]

string

Opcional. Filtro de productos por exclusión de ID de artículo para la promoción Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
brand_exclusion[]

string

Opcional. Filtro de productos por exclusión de marca para la promoción Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
item_group_id_exclusion[]

string

Opcional. Filtro de productos por ID de grupo de artículos Los atributos del filtro de productos solo se aplican cuando el atributo product_applicability de aplicabilidad del producto apto para la promoción está configurado en specific_products.
product_type_exclusion[]

string

Opcional. Filtro de productos por exclusión de tipo de producto para la promoción Los atributos del filtro de productos solo se aplican cuando el atributo aplicabilidad del producto product_applicability de los productos aptos para la promoción está configurado en specific_products.
minimum_purchase_amount

Price

Opcional. Es el importe mínimo de compra para la promoción.
minimum_purchase_quantity

int64

Opcional. Cantidad mínima de compra para la promoción.
limit_quantity

int64

Opcional. Cantidad máxima de compra para la promoción.
limit_value

Price

Opcional. Precio máximo del producto para la promoción.
percent_off

int64

Opcional. Es el porcentaje de descuento que se ofrece en la promoción.
money_off_amount

Price

Opcional. Es el importe de descuento que se ofrece en la promoción.
get_this_quantity_discounted

int64

Opcional. Es la cantidad de artículos con descuento en la promoción. El atributo se establece cuando couponValueType es igual a buy_m_get_n_money_off o buy_m_get_n_percent_off.
free_gift_value

Price

Opcional. Valor de regalo de cortesía para la promoción.
free_gift_description

string

Opcional. Descripción del regalo de cortesía de la promoción.
free_gift_item_id

string

Opcional. ID de artículo de regalo de cortesía de la promoción.
promotion_effective_time_period

Interval

Obligatorio. TimePeriod representación de las fechas de entrada en vigencia de la promoción. Con este atributo, se especifica que la promoción se puede probar en tu tienda en línea durante este período.
promotion_display_time_period

Interval

Opcional. Representación TimePeriod de las fechas de visualización de la promoción. En este atributo, se especifica la fecha y hora en que se publicará la promoción en Google.com y en los anuncios de Shopping. Si no se especifica el atributo período de visualización de la promoción promotion_display_time_period, el período de vigencia de la promoción promotion_effective_time_period determina la fecha y el período en los que se publicará la promoción en Google.com y los anuncios de Shopping.
store_applicability

StoreApplicability

Opcional. Indica si la promoción se aplica a todas las tiendas o solo a tiendas específicas. Las promociones de anuncios del inventario local muestran un error si no se incluye la aplicabilidad a la tienda. Se genera un error INVALID_ARGUMENT si store_applicability se establece en ALL_STORES y store_codes_inclusion o score_code_exclusion se establece en un valor.
store_codes_inclusion[]

string

Opcional. Códigos de tienda que se incluirán para la promoción. Los atributos del filtro de tiendas solo se aplican cuando el atributo store_applicability está configurado en specific_stores.

Es el código de tienda (el ID de tu Perfil de Negocio) de la tienda física en la que se vende el producto. Consulta las especificaciones de datos del inventario de productos locales para obtener más información.
store_codes_exclusion[]

string

Opcional. Códigos de tiendas que se excluirán para la promoción. Los atributos del filtro de tiendas solo se aplican cuando el atributo store_applicability está configurado en specific_stores.
promotion_url

string

Opcional. Es la URL de la página del sitio del comercio en la que se muestra la promoción. Las promociones de anuncios del inventario local arrojan un error si no se incluye promotion_url. La URL se usa para confirmar que la promoción es válida y se puede canjear.

CouponValueType

Es el tipo de valor del cupón de una promoción.

Enumeraciones
COUPON_VALUE_TYPE_UNSPECIFIED Indica que no se especificó el tipo de valor del cupón.
MONEY_OFF Tipo de valor del cupón de descuento.
PERCENT_OFF Es el tipo de valor del cupón de porcentaje de descuento.
BUY_M_GET_N_MONEY_OFF Comprar M para obtener N de descuento minimum_purchase_quantity y get_this_quantity_discounted deben estar presentes. money_off_amount también debe estar presente.
BUY_M_GET_N_PERCENT_OFF Compre una cantidad M y obtenga un n% de descuento en el tipo de valor del cupón. minimum_purchase_quantity y get_this_quantity_discounted deben estar presentes. percent_off_percentage también debe estar presente.
BUY_M_GET_MONEY_OFF Compre una cantidad M y obtenga un descuento. minimum_purchase_quantity y money_off_amount deben estar presentes.
BUY_M_GET_PERCENT_OFF Comprar M para obtener un descuento. minimum_purchase_quantity y percent_off_percentage deben estar presentes.
FREE_GIFT Regalo de cortesía con solo descripción
FREE_GIFT_WITH_VALUE Regalo de cortesía con valor monetario
FREE_GIFT_WITH_ITEM_ID Regalo de cortesía con ID de artículo
FREE_SHIPPING_STANDARD Tipo de valor del cupón de envío gratis estándar.
FREE_SHIPPING_OVERNIGHT Tipo de valor del cupón de envío gratis al día siguiente.
FREE_SHIPPING_TWO_DAY Tipo de valor del cupón de envío gratis en dos días.

GetPromotionRequest

Mensaje de la solicitud para el método GetPromotion.

Campos
name

string

Obligatorio. Es el nombre de la promoción que se recuperará. Formato: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Mensaje de la solicitud para el método InsertPromotion.

Campos
parent

string

Obligatorio. La cuenta en la que se insertará la promoción. Formato: accounts/{account}
promotion

Promotion

Obligatorio. Es la promoción que se insertará.
data_source

string

Obligatorio. La fuente de datos de la promoción tiene el formato accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Mensaje de la solicitud para el método ListPromotions.

Campos
parent

string

Obligatorio. La cuenta para la que se mostrarán las promociones procesadas. Formato: accounts/{account}
page_size

int32

Solo salida. Es la cantidad máxima de promociones que se mostrarán. El servicio puede mostrar menos que este valor. El valor máximo es 250; los valores superiores a 250 se convertirán a 250. Si no se especifica, se devolverá la cantidad máxima de promociones.
page_token

string

Solo salida. Un token de página, recibido desde una llamada ListPromotions anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListPromotions deben coincidir con la llamada que proporcionó el token de la página.

ListPromotionsResponse

Mensaje de respuesta para el método ListPromotions.

Campos
promotions[]

Promotion

Las promociones procesadas de la cuenta especificada.
next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

OfferType

Es el tipo de oferta de una promoción.

Enumeraciones
OFFER_TYPE_UNSPECIFIED El tipo de oferta es desconocido.
NO_CODE Tipo de oferta sin código.
GENERIC_CODE Tipo de oferta con un código Se requiere un código de canje genérico para la promoción cuando offerType = GENERIC_CODE.

ProductApplicability

A qué producto o lista de productos se aplica la promoción.

Enumeraciones
PRODUCT_APPLICABILITY_UNSPECIFIED No se sabe a qué productos se aplica la promoción.
ALL_PRODUCTS Se aplica a todos los productos.
SPECIFIC_PRODUCTS Solo se aplica a un solo producto o a una lista de productos.

Promoción

Representa una promoción. Consulta los siguientes artículos para obtener más detalles.

A continuación, se definen los atributos de entrada de promoción obligatorios para aprobar las verificaciones de validación de datos:

Después de insertarla y actualizar una entrada de promoción, pueden pasar varios minutos antes de que se pueda recuperar la promoción final.

Campos
name

string

Identificador. Es el nombre de la promoción. Formato: accounts/{account}/promotions/{promotion}
promotion_id

string

Obligatorio. El usuario proporcionó el ID de la promoción para identificarla de forma única. Sigue los requisitos mínimos para evitar que se rechacen las promociones.
content_language

string

Obligatorio. Es el código de idioma ISO 639-1 de dos letras de la promoción.

Las promociones están disponibles solo para idiomas seleccionados.
target_country

string

Obligatorio. Es el país de destino que se usa como parte del identificador único. Se representa como un código de territorio de CLDR.

Las promociones solo están disponibles en países seleccionados. Fichas gratuitas y anuncios de Shopping Anuncios del inventario local
redemption_channel[]

RedemptionChannel

Obligatorio. Canal de canje de la promoción. Se requiere al menos un canal.
data_source

string

Solo salida. Es la fuente de datos principal de la promoción.
attributes

Attributes

Opcional. Es una lista de atributos de promoción.
custom_attributes[]

CustomAttribute

Opcional. Es una lista de atributos personalizados (proporcionados por el comercio). También se puede usar para enviar cualquier atributo de la especificación de datos en su forma genérica (por ejemplo, { "name": "size type", "value": "regular" }). Esto es útil para enviar atributos que la API no expone de forma explícita.
promotion_status

PromotionStatus

Solo salida. El estado de una promoción, problemas de validación de datos, es decir, información sobre una promoción calculada de forma asíncrona.
version_number

int64

Opcional. Representa la versión existente (actualización) de la promoción, que se puede usar para preservar el orden correcto cuando se realizan varias actualizaciones al mismo tiempo.

Si se establece, se evita la inserción cuando el número de versión es inferior al número de versión actual de la promoción existente. La inserción nuevamente (por ejemplo, la actualización de la promoción después de 30 días) se puede realizar con el version_number actual.

Si se evita la operación, se arrojará la excepción abortada.

PromotionStatus

Es el estado de la promoción.

Campos
destination_statuses[]

DestinationStatus

Solo salida. Los destinos previstos para la promoción.
item_level_issues[]

ItemLevelIssue

Solo salida. Una lista de problemas asociados con la promoción.
creation_date

Timestamp

Solo salida. Es la fecha en la que se creó la promoción en formato ISO 8601: fecha, hora y desplazamiento, por ejemplo, 2020-01-02T09:00:00+01:00 o 2020-01-02T09:00:00Z.
last_update_date

Timestamp

Solo salida. Es la fecha en la que se actualizó por última vez el estado de la promoción en formato ISO 8601: fecha, hora y desplazamiento, por ejemplo, 2020-01-02T09:00:00+01:00 o 2020-01-02T09:00:00Z.

DestinationStatus

El estado del destino especificado.

Campos
reporting_context

ReportingContextEnum

Solo salida. Es el nombre del destino de la promoción.
status

State

Solo salida. El estado del destino especificado.

Estado

Es el estado actual de la promoción.

Enumeraciones
STATE_UNSPECIFIED Estado de promoción desconocido.
IN_REVIEW La promoción está en proceso de revisión.
REJECTED Se rechazó la promoción.
LIVE La promoción está aprobada y activa.
STOPPED El comercio detuvo la promoción.
EXPIRED La promoción ya no está activa.
PENDING La promoción no se detuvo y se aprobaron todas las opiniones, pero la fecha de activación es futura.

ItemLevelIssue

El problema asociado con la promoción.

Campos
code

string

Solo salida. El código de error del problema.
severity

Severity

Solo salida. Cómo afecta este problema a la publicación de la promoción
resolution

string

Solo salida. Si el comercio puede resolver el problema.
attribute

string

Solo salida. El nombre del atributo, si el problema se debe a un solo atributo.
reporting_context

ReportingContextEnum

Solo salida. El destino al que se aplica el problema.
description

string

Solo salida. Una breve descripción del problema en inglés.
detail

string

Solo salida. Una descripción detallada del problema en inglés.
documentation

string

Solo salida. La URL de una página web para ayudar a resolver este problema
applicable_countries[]

string

Solo salida. Es la lista de códigos de país (ISO 3166-1 alpha-2) en los que el problema se aplica a la oferta.

Gravedad

La gravedad del problema.

Enumeraciones
SEVERITY_UNSPECIFIED No se especifica.
NOT_IMPACTED Este problema representa una advertencia y no tiene un efecto directo en la promoción.
DEMOTED La promoción se degrada y, lo más probable, es que tenga un rendimiento limitado en los resultados de la búsqueda.
DISAPPROVED El problema rechaza la promoción.

RedemptionChannel

Es el canal de una promoción.

Enumeraciones
REDEMPTION_CHANNEL_UNSPECIFIED Indica que el canal no está especificado.
IN_STORE Indica que el canal está en la tienda. Es igual que el canal local que se usa para products.
ONLINE Indica que el canal está en línea.

StoreApplicability

Códigos de tienda o listas de códigos de tienda a los que se aplica la promoción Solo para promociones de anuncios del inventario local.

Enumeraciones
STORE_APPLICABILITY_UNSPECIFIED No se sabe a qué códigos de tienda se aplica la promoción.
ALL_STORES La promoción se aplica a todas las tiendas.
SPECIFIC_STORES La promoción se aplica solo a las tiendas especificadas.