REST Resource: accounts.programs

Ressource: Programme

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

Ces programmes permettent d'ajouter des fonctionnalités aux comptes marchands. Le programme Fiches produit sans frais en est un exemple typique. Il permet aux produits d'un marchand d'apparaître sans frais 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 où toutes les conditions du programme applicables dans ces régions sont remplies.

Les codes de région sont définis par le CLDR. Il peut s'agir d'un pays où le programme s'applique spécifiquement ou de 001 lorsque le programme s'applique à l'échelle mondiale.

unmetRequirements[]

object (Requirement)

Uniquement en sortie. Les conditions non encore remplies pour le compte et qui ont une incidence sur la participation au programme

État

États de participation possibles au programme pour le compte.

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

Exigence

Définit une condition requise pour participer 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 cette exigence non respectées.

Les codes de région sont définis par le CLDR. Il peut s'agir d'un pays où le programme s'applique spécifiquement ou de 001 lorsque le programme s'applique à l'échelle mondiale.

Méthodes

disable

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

enable

Autoriser la participation du compte au programme spécifié.

get

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

list

Récupère tous les programmes du compte.