REST Resource: accounts.programs

Ressource: Programme

Définit la participation à un programme donné pour le compte spécifié.

Les programmes permettent d'ajouter des fonctionnalités aux comptes marchands. C'est le cas, par exemple, du programme Fiches produit sans frais, qui permet de présenter sans frais les produits d'un marchand sur Google.

Représentation JSON 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Champs
name

string

Identifiant. Nom de ressource du programme. Format : accounts/{account}/programs/{program}
documentationUri

string

Uniquement en sortie. URL d'une page d'aide Merchant Center décrivant le programme.
state

enum (State)

Uniquement en sortie. État de participation du compte au programme.
activeRegionCodes[]

string

Uniquement en sortie. Régions dans lesquelles le compte participe activement au programme. Les régions actives sont celles pour lesquelles toutes les exigences du programme les concernant ont été remplies.

Les codes de région sont définis par le CLDR. Il s'agit d'un pays où le programme s'applique spécifiquement ou de 001 lorsque le programme s'applique dans le monde entier.
unmetRequirements[]

object (Requirement)

Uniquement en sortie. Exigences auxquelles le compte n'a pas encore satisfait, ce qui empêche sa participation au programme.

État

États de participation au programme possibles pour le compte.

Enums
STATE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
NOT_ELIGIBLE Le compte n'est pas éligible au programme.
ELIGIBLE Le compte est éligible au programme.
ENABLED Le programme est activé pour le compte.

Exigence

Définit une exigence spécifiée pour la participation au programme.

Représentation JSON 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Champs
title

string

Uniquement en sortie. Nom de l'exigence.
documentationUri

string

Uniquement en sortie. URL d'une page d'aide décrivant l'exigence.
affectedRegionCodes[]

string

Uniquement en sortie. Régions actuellement concernées par le non-respect de cette exigence

Les codes de région sont définis par le CLDR. Il s'agit d'un pays où le programme s'applique spécifiquement ou de 001 lorsque le programme s'applique dans le monde entier.

Méthodes

disable

 Désactivez la participation au programme spécifié pour le compte.

enable

 Activez la participation au programme spécifié pour le compte.

get

 Récupère le programme spécifié pour le compte.

list

 Récupère tous les programmes du compte.