REST Resource: accounts.promotions

Ressource: 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.

Représentation 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
}
Champs
name

string

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

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.
contentLanguage

string

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

Les promotions ne sont disponibles que dans certaines langues.
targetCountry

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, fiches gratuites et annonces Shopping annonces produits en magasin
redemptionChannel[]

enum (RedemptionChannel)

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

string

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

object (Attributes)

Facultatif. Liste des attributs de promotion.
customAttributes[]

object (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.
promotionStatus

object (PromotionStatus)

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

string (int64 format)

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

Si cette règle est définie, l'insertion n'est pas possible lorsque le numéro de version est inférieur à celui de la promotion existante. La réinsertion (par exemple, l'actualisation de la promotion après 30 jours) peut être effectuée avec l'versionNumber actuelle.

Si l'opération est empêchée, l'exception "aborted" est généré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.

Attributs

Attributs.

Représentation 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
}
Champs
productApplicability

enum (ProductApplicability)

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

enum (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.
genericRedemptionCode

string

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

string

Obligatoire. Titre long de la promotion.
couponValueType

enum (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.
promotionDestinations[]

enum (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 s'affichera par défaut dans les annonces Shopping et 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 ou LOCAL_INVENTORY_ADS. Pour en savoir plus, consultez Destination de la promotion
itemIdInclusion[]

string

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

string

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

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 [productApplicability] est défini sur specific_products.
productTypeInclusion[]

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 productApplicability produits concernés par la promotion est défini sur specific_products.
itemIdExclusion[]

string

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

string

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

string

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

string

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

object (Price)

Facultatif. Montant minimal d'achat associé à la promotion.
minimumPurchaseQuantity

string (int64 format)

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

string (int64 format)

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

object (Price)

Facultatif. Prix maximal du produit pour la promotion.
percentOff

string (int64 format)

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

object (Price)

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

string (int64 format)

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.
freeGiftValue

object (Price)

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

string

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

string

Facultatif. Identifiant du cadeau sans frais pour la promotion.
promotionEffectiveTimePeriod

object (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 sur votre boutique en ligne pendant cette période.
promotionDisplayTimePeriod

object (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 promotionDisplayTimePeriod, la période de validité de la promotion promotionEffectiveTimePeriod correspond à la période au cours de laquelle la promotion sera diffusée sur Google.com et dans les annonces Shopping.
storeApplicability

enum (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 générée si storeApplicability est défini sur ALL_STORES et que storeCodesInclusion ou score_code_exclusion est défini sur une valeur.
storeCodesInclusion[]

string

Facultatif. Codes de magasin à inclure pour la promotion. Les attributs de filtre de magasin ne s'appliquent que lorsque l'attribut storeApplicability 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.
storeCodesExclusion[]

string

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

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 promotionUrl n'est inclus. L'URL permet de vérifier que la promotion est valide et peut être utilisée.

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 Applicable à un seul produit ou à une seule liste de produits.

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.

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 de bon de réduction avec remise.
PERCENT_OFF Type de valeur de bon de réduction en pourcentage.
BUY_M_GET_N_MONEY_OFF N de remise sur un type de valeur de bon de réduction pour M produits achetés. minimumPurchaseQuantity et getThisQuantityDiscounted doivent être présents. moneyOffAmount 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) minimumPurchaseQuantity et getThisQuantityDiscounted doivent être présents. percent_off_percentage doit également être présent.
BUY_M_GET_MONEY_OFF Bénéficiez d'une remise pour M produits achetés. minimumPurchaseQuantity et moneyOffAmount doivent être présents.
BUY_M_GET_PERCENT_OFF Remise pour x produits achetés. minimumPurchaseQuantity 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 d'un bon de réduction standard pour livraison gratuite.
FREE_SHIPPING_OVERNIGHT Type de valeur du bon de réduction "Livraison gratuite sous 24h".
FREE_SHIPPING_TWO_DAY Type de valeur du bon de réduction pour la livraison gratuite sous 48 h.

DestinationEnum

Valeurs de destination.

Enums
DESTINATION_ENUM_UNSPECIFIED Non spécifié.
SHOPPING_ADS Annonces Shopping :
DISPLAY_ADS Annonces display :
LOCAL_INVENTORY_ADS Les annonces produits en magasin :
FREE_LISTINGS Free listings :
FREE_LOCAL_LISTINGS Fiches produit locales gratuites :
YOUTUBE_SHOPPING YouTube Shopping
YOUTUBE_SHOPPING_CHECKOUT Paiement sur YouTube Shopping.
YOUTUBE_AFFILIATE Affilié YouTube
FREE_VEHICLE_LISTINGS Fiches gratuites pour des véhicules
VEHICLE_ADS Annonces pour des véhicules
CLOUD_RETAIL Cloud Retail
LOCAL_CLOUD_RETAIL Cloud Retail local.

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.

PromotionStatus

État de la promotion.

Représentation JSON 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string
}
Champs
destinationStatuses[]

object (DestinationStatus)

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

object (ItemLevelIssue)

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

string (Timestamp format)

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
lastUpdateDate

string (Timestamp format)

Uniquement en sortie. Date à laquelle l'état de la promotion a été mis à jour pour la dernière fois 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.

Représentation JSON 
{
  "reportingContext": enum (ReportingContextEnum),
  "status": enum (State)
}
Champs
reportingContext

enum (ReportingContextEnum)

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

enum (State)

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

État

État actuel de la promotion.

Enums
STATE_UNSPECIFIED État de 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.

Représentation JSON 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
Champs
code

string

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

enum (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
reportingContext

enum (ReportingContextEnum)

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

string

Uniquement en sortie. Une brève description 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 qui vous aide à résoudre ce problème.
applicableCountries[]

string

Uniquement en sortie. Liste des codes pays (ISO 3166-1 alpha-2) auxquels le problème s'applique pour 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 Un problème entraîne le refus de la promotion.

Méthodes

get

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

insert

 Insère une promotion pour votre compte Merchant Center.

list

 Répertorie les promotions de votre compte Merchant Center.