Package google.shopping.merchant.promotions.v1beta

Index

PromotionsService

Service permettant de gérer les promotions des produits.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Récupère la promotion de votre compte Merchant Center.

Après avoir inséré ou mis à jour une entrée de promotion, plusieurs minutes peuvent s'écouler avant que la promotion mise à jour puisse être récupérée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Insère une promotion pour votre compte Merchant Center. Si la promotion existe déjà, elle est mise à jour.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Répertorie les promotions de votre compte Merchant Center. La réponse peut contenir moins d'éléments que ceux spécifiés par pageSize. Utilisez pageToken pour déterminer s'il existe d'autres éléments à demander.

Après avoir inséré ou mis à jour une promotion, plusieurs minutes peuvent s'écouler avant que la promotion traitée mise à jour puisse être récupérée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez OAuth 2.0 Overview.

Attributs

Attributs.

Champs
product_applicability

ProductApplicability

Obligatoire. Applicabilité de la promotion à tous les produits ou uniquement à des produits spécifiques.
offer_type

OfferType

Obligatoire. Type de la promotion. Utilisez cet attribut pour indiquer si les clients ont besoin d'un code promotionnel pour bénéficier de votre promotion.
generic_redemption_code

string

Facultatif. Code promotionnel générique de la promotion. À utiliser avec le champ offerType et doit respecter les conditions minimales requises.
long_title

string

Obligatoire. Titre long de la promotion.
coupon_value_type

CouponValueType

Obligatoire. L'attribut type de valeur de bon de réduction pour indiquer le type de promotion que vous proposez. Selon le type de valeur de bon de réduction sélectionné, certains attributs sont obligatoires.
promotion_destinations[]

DestinationEnum

Obligatoire. Liste des destinations auxquelles la promotion s'applique. Si vous ne spécifiez pas de destination en incluant une valeur acceptée dans votre source de données, votre promotion sera diffusée par défaut dans les annonces Shopping et dans les fiches gratuites.

Vous avez peut-être déjà envoyé les valeurs suivantes en tant que destinations pour vos produits: Shopping Actions, Surfaces sur Google et Surfaces locales sur Google. Pour représenter ces valeurs, utilisez FREE_LISTINGS, FREE_LOCAL_LISTINGS et LOCAL_INVENTORY_ADS. Pour en savoir plus, consultez Destination de la promotion.
item_id_inclusion[]

string

Facultatif. Filtre de produits par ID d'article pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
brand_inclusion[]

string

Facultatif. Filtre de produits par marque pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
item_group_id_inclusion[]

string

Facultatif. Filtre de produits par identifiant de groupe d'articles pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut produits concernés par la promotion [product_applicability] est défini sur specific_products.
product_type_inclusion[]

string

Facultatif. Filtre de produits par type de produit pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
item_id_exclusion[]

string

Facultatif. Filtre de produits par exclusion d'ID d'article pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
brand_exclusion[]

string

Facultatif. Filtre de produits par marque exclue pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
item_group_id_exclusion[]

string

Facultatif. Filtre de produits par identifiant de groupe d'articles. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut produits concernés par la promotion product_applicability est défini sur specific_products.
product_type_exclusion[]

string

Facultatif. Filtre de produits par exclusion de type de produit pour la promotion. Les attributs de filtre de produits ne s'appliquent que lorsque l'attribut product_applicability produits concernés par la promotion est défini sur specific_products.
minimum_purchase_amount

Price

Facultatif. Montant minimal d'achat pour la promotion.
minimum_purchase_quantity

int64

Facultatif. Quantité minimale d'articles à acheter pour la promotion.
limit_quantity

int64

Facultatif. Quantité maximale par commande pour la promotion.
limit_value

Price

Facultatif. Prix maximal du produit pour la promotion.
percent_off

int64

Facultatif. Pourcentage de remise sans frais dans la promotion.
money_off_amount

Price

Facultatif. Montant de la remise proposé dans la promotion.
get_this_quantity_discounted

int64

Facultatif. Nombre d'articles en promotion. L'attribut est défini lorsque couponValueType est égal à buy_m_get_n_money_off ou buy_m_get_n_percent_off.
free_gift_value

Price

Facultatif. Valeur du cadeau sans frais pour la promotion.
free_gift_description

string

Facultatif. Description du cadeau sans frais de la promotion.
free_gift_item_id

string

Facultatif. Identifiant de l'article du cadeau sans frais pour la promotion.
promotion_effective_time_period

Interval

Obligatoire. TimePeriod : représentation des dates d'entrée en vigueur de la promotion. Cet attribut indique que la promotion peut être testée dans votre boutique en ligne pendant cette période.
promotion_display_time_period

Interval

Facultatif. TimePeriod : représentation des dates de diffusion de la promotion. Cet attribut permet d'indiquer la période au cours de laquelle la promotion sera diffusée sur Google.fr et dans les annonces Shopping. Si vous ne définissez pas la période de diffusion de l'attribut promotion promotion_display_time_period, la période de validité de la promotion promotion_effective_time_period correspond à la période au cours de laquelle la promotion sera diffusée sur Google.com et dans les annonces Shopping.
store_applicability

StoreApplicability

Facultatif. Indique si la promotion s'applique à tous les magasins ou uniquement à certains d'entre eux. Les promotions des annonces produits en magasin génèrent une erreur si aucune applicabilité de magasin n'est incluse. Une erreur INVALID_ARGUMENT est renvoyée si store_applicability est défini sur ALL_STORES et que store_codes_inclusion ou score_code_exclusion est défini sur une valeur.
store_codes_inclusion[]

string

Facultatif. Codes de magasin à inclure pour la promotion. Les attributs de filtre de magasin ne s'appliquent que lorsque l'attribut store_applicability est défini sur specific_stores.

Code de magasin (identifiant du magasin dans votre fiche d'établissement) du magasin physique dans lequel le produit est vendu. Pour en savoir plus, consultez les spécifications des données d'inventaire de produits en magasin.
store_codes_exclusion[]

string

Facultatif. Codes de magasin à exclure pour la promotion. Les attributs de filtre de magasin ne s'appliquent que lorsque l'attribut store_applicability est défini sur specific_stores.
promotion_url

string

Facultatif. URL de la page du site du marchand sur laquelle la promotion s'affiche. Les promotions des annonces produits en magasin génèrent une erreur si aucun promotion_url n'est inclus. L'URL permet de vérifier que la promotion est valide et peut être utilisée.

CouponValueType

Type de valeur de bon de réduction d'une promotion.

Enums
COUPON_VALUE_TYPE_UNSPECIFIED Indique que le type de valeur du bon de réduction n'est pas spécifié.
MONEY_OFF Type de valeur du bon de réduction avec remise.
PERCENT_OFF Type de valeur de bon de réduction en pourcentage.
BUY_M_GET_N_MONEY_OFF Type de valeur de bon de réduction : remise pour M produits achetés. minimum_purchase_quantity et get_this_quantity_discounted doivent être présents. money_off_amount doit également être présent.
BUY_M_GET_N_PERCENT_OFF N pour cent de remise pour M produits achetés (type de valeur du bon de réduction) minimum_purchase_quantity et get_this_quantity_discounted doivent être présents. percent_off_percentage doit également être présent.
BUY_M_GET_MONEY_OFF Remise pour x produits achetés. minimum_purchase_quantity et money_off_amount doivent être présents.
BUY_M_GET_PERCENT_OFF Remise pour x produits achetés. minimum_purchase_quantity et percent_off_percentage doivent être présents.
FREE_GIFT Cadeau sans frais avec description uniquement.
FREE_GIFT_WITH_VALUE Cadeau sans frais à valeur monétaire.
FREE_GIFT_WITH_ITEM_ID Cadeau avec ID de l'article.
FREE_SHIPPING_STANDARD Type de valeur de bon de réduction pour la livraison standard sans frais. Disponible uniquement pour les promotions en ligne.
FREE_SHIPPING_OVERNIGHT Type de valeur du bon de réduction pour la livraison gratuite sous 24h. Disponible uniquement pour les promotions en ligne.
FREE_SHIPPING_TWO_DAY Type de valeur du bon de réduction pour la livraison gratuite sous 48 h. Disponible uniquement pour les promotions en ligne.

GetPromotionRequest

Message de requête pour la méthode GetPromotion.

Champs
name

string

Obligatoire. Nom de la promotion à récupérer. Format : accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Message de requête pour la méthode InsertPromotion.

Champs
parent

string

Obligatoire. Compte dans lequel la promotion sera insérée. Format: accounts/{account}
promotion

Promotion

Obligatoire. Promotion à insérer.
data_source

string

Obligatoire. Source de données de la promotion: accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Message de requête pour la méthode ListPromotions.

Champs
parent

string

Obligatoire. Compte pour lequel lister les promotions traitées. Format : accounts/{account}
page_size

int32

Uniquement en sortie. Nombre maximal de promotions à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. La valeur maximale est 250. Les valeurs supérieures sont réduites à 250. Si ce paramètre n'est pas spécifié, le nombre maximal de promotions est renvoyé.
page_token

string

Uniquement en sortie. Jeton de page reçu d'un appel ListPromotions précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListPromotions doivent correspondre à l'appel ayant fourni le jeton de page.

ListPromotionsResponse

Message de réponse pour la méthode ListPromotions.

Champs
promotions[]

Promotion

Promotions traitées du compte spécifié.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

OfferType

Type d'offre d'une promotion.

Enums
OFFER_TYPE_UNSPECIFIED Type d'offre inconnu.
NO_CODE Type d'offre sans code
GENERIC_CODE Type d'offre avec un code Le code promotionnel générique de la promotion est obligatoire lorsque offerType = GENERIC_CODE.

ProductApplicability

Produit ou liste de produits auxquels la promotion s'applique.

Enums
PRODUCT_APPLICABILITY_UNSPECIFIED Les produits concernés par la promotion sont inconnus.
ALL_PRODUCTS Applicable à tous les produits.
SPECIFIC_PRODUCTS Ne s'applique qu'à un seul produit ou à une liste de produits.

Promotion

Représente une promotion. Pour en savoir plus, consultez les articles suivants.

Les attributs d'entrée de promotion obligatoires pour réussir les contrôles de validation des données sont principalement définis ci-dessous:

Une fois que vous avez inséré ou mis à jour une promotion, il peut s'écouler plusieurs minutes avant que la promotion finale puisse être récupérée.

Champs
name

string

Identifiant. Nom de la promotion. Format : accounts/{account}/promotions/{promotion}
promotion_id

string

Obligatoire. L'utilisateur a fourni l'identifiant de la promotion pour l'identifier de manière unique. Respectez les exigences minimales pour éviter que vos promotions soient refusées.
content_language

string

Obligatoire. Code de langue ISO 639-1 à deux lettres de la promotion.

Les promotions ne sont disponibles que dans certaines langues.
target_country

string

Obligatoire. Pays cible utilisé dans l'identifiant unique. Représenté par un code de territoire CLDR.

Les promotions ne sont disponibles que dans certains pays, pour les fiches gratuites et les annonces Shopping les annonces produits en magasin
redemption_channel[]

RedemptionChannel

Obligatoire. Canal d'utilisation de la promotion. Veuillez indiquer au moins un canal.
data_source

string

Uniquement en sortie. Source de données principale de la promotion.
attributes

Attributes

Facultatif. Liste des attributs de promotion.
custom_attributes[]

CustomAttribute

Facultatif. Liste d'attributs personnalisés (fournis par le marchand). Elle peut également être utilisée pour envoyer n'importe quel attribut des spécifications des données sous sa forme générique (par exemple, { "name": "size type", "value": "regular" }). Cela est utile pour envoyer des attributs non explicitement indiqués par l'API.
promotion_status

PromotionStatus

Uniquement en sortie. État d'une promotion, problèmes de validation des données, c'est-à-dire informations sur une promotion calculées de manière asynchrone.
version_number

int64

Facultatif. Représente la version existante (fraîcheur) de la promotion, qui peut être utilisée pour conserver l'ordre correct lorsque plusieurs mises à jour sont effectuées en même temps.

Si cet argument est défini, l'insertion est empêchée lorsque le numéro de version est inférieur au numéro de version actuel de la promotion existante. La réinsertion (par exemple, l'actualisation de la promotion après 30 jours) peut être effectuée avec l'version_number actuelle.

Si l'opération est empêchée, l'exception "aborted" est générée.

PromotionStatus

État de la promotion.

Champs
destination_statuses[]

DestinationStatus

Uniquement en sortie. Destinations prévues pour la promotion
item_level_issues[]

ItemLevelIssue

Uniquement en sortie. Liste des problèmes associés à la promotion.
creation_date

Timestamp

Uniquement en sortie. Date de création de la promotion, au format ISO 8601: date, heure et décalage, par exemple 2020-01-02T09:00:00+01:00 ou 2020-01-02T09:00:00Z
last_update_date

Timestamp

Uniquement en sortie. Date de la dernière mise à jour de l'état de la promotion au format ISO 8601: date, heure et décalage, par exemple 2020-01-02T09:00:00+01:00 ou 2020-01-02T09:00:00Z

DestinationStatus

État de la destination spécifiée.

Champs
reporting_context

ReportingContextEnum

Uniquement en sortie. Nom de la destination de la promotion.
status

State

Uniquement en sortie. État de la destination spécifiée.

État

État actuel de la promotion.

Enums
STATE_UNSPECIFIED État de la promotion inconnu.
IN_REVIEW La promotion est en cours d'examen.
REJECTED La promotion est refusée.
LIVE La promotion est approuvée et active.
STOPPED La promotion est arrêtée par le marchand.
EXPIRED La promotion n'est plus active.
PENDING La promotion n'est pas arrêtée et toutes les évaluations sont approuvées, mais la date d'activation est à venir.

ItemLevelIssue

Problème associé à la promotion.

Champs
code

string

Uniquement en sortie. Code d'erreur du problème
severity

Severity

Uniquement en sortie. Indique comment ce problème affecte la diffusion de la promotion
resolution

string

Uniquement en sortie. Indique si le problème peut être résolu par le marchand
attribute

string

Uniquement en sortie. Si le problème est causé par un attribut unique, nom de cet attribut
reporting_context

ReportingContextEnum

Uniquement en sortie. Destination concernée par le problème
description

string

Uniquement en sortie. Description courte du problème en anglais.
detail

string

Uniquement en sortie. Description détaillée du problème en anglais
documentation

string

Uniquement en sortie. URL d'une page Web d'aide pour résoudre ce problème
applicable_countries[]

string

Uniquement en sortie. Liste des codes pays (ISO 3166-1 alpha-2) dans lesquels le problème s'applique à l'offre.

Gravité

Gravité du problème.

Enums
SEVERITY_UNSPECIFIED Non spécifié.
NOT_IMPACTED Il s'agit d'un avertissement qui n'a aucune incidence directe sur la promotion.
DEMOTED La promotion est rétrogradée et ses performances dans les résultats de recherche sont probablement limitées.
DISAPPROVED La promotion est refusée.

RedemptionChannel

Canal d'une promotion.

Enums
REDEMPTION_CHANNEL_UNSPECIFIED Indique que la chaîne n'est pas spécifiée.
IN_STORE Indique que la chaîne est disponible en magasin. Il s'agit du même canal local que celui utilisé pour products.
ONLINE Indique que la chaîne est en ligne.

StoreApplicability

Codes de magasin ou liste des codes de magasin auxquels la promotion s'applique. Uniquement pour les promotions des annonces produits en magasin.

Enums
STORE_APPLICABILITY_UNSPECIFIED Les codes de magasin auxquels la promotion s'applique sont inconnus.
ALL_STORES La promotion s'applique à tous les magasins.
SPECIFIC_STORES La promotion ne s'applique qu'aux magasins spécifiés.