REST Resource: accounts.programs

Recurso: Program

Define la participación en un programa determinado para la cuenta especificada.

Los programas ofrecen un mecanismo para agregar funciones a las cuentas de comerciante. Un ejemplo típico de esto es el programa Fichas de producto gratuitas, que permite que los productos de la tienda de un comercio se muestren en Google de forma gratuita.

Representación JSON 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Campos
name

string

Identificador. Es el nombre del recurso del programa. Formato: accounts/{account}/programs/{program}
documentationUri

string

Solo salida. Es la URL de una página de ayuda de Merchant Center en la que se describe el programa.
state

enum (State)

Solo salida. El estado de participación de la cuenta en el programa.
activeRegionCodes[]

string

Solo salida. Indica las regiones en las que la cuenta participa de forma activa en el programa. Las regiones activas se definen como aquellas en las que se cumplen todos los requisitos del programa que afectan a las regiones.

CLDR define los códigos regionales. Es un país donde el programa se aplica específicamente a ese país o 001 cuando se aplica a nivel mundial.
unmetRequirements[]

object (Requirement)

Solo salida. Son los requisitos que la cuenta aún no cumple y que afectan la participación en el programa.

Estado

Estados posibles de participación en el programa de la cuenta.

Enumeraciones
STATE_UNSPECIFIED Valor predeterminado Este valor no se usa.
NOT_ELIGIBLE La cuenta no es apta para participar en el programa.
ELIGIBLE La cuenta es apta para participar en el programa.
ENABLED El programa está habilitado para la cuenta.

Requisito

Define un requisito especificado para participar en el programa.

Representación JSON 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Campos
title

string

Solo salida. Es el nombre del requisito.
documentationUri

string

Solo salida. Es la URL de una página de ayuda en la que se describe el requisito.
affectedRegionCodes[]

string

Solo salida. No se cumplen las regiones que actualmente se ven afectadas por este requisito.

CLDR define los códigos regionales. Es un país donde el programa se aplica específicamente a ese país o 001 cuando se aplica a nivel mundial.

Métodos

disable

 Inhabilitar la participación en el programa especificado para la cuenta.

enable

 Habilitar la participación en el programa especificado para la cuenta.

get

 Recupera el programa especificado para la cuenta.

list

 Recupera todos los programas de la cuenta.