REST Resource: accounts.programs

Recurso: Program

Define a participação da conta especificada em um determinado programa.

Os programas oferecem um mecanismo para adicionar funcionalidades às contas do comerciante. Um exemplo típico disso é o programa de listagens de produto sem custo financeiro, que permite que os produtos da loja de um comerciante sejam exibidos no Google sem custo financeiro.

Representação JSON 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Campos
name

string

Identificador. O nome de recurso do programa. Formato: accounts/{account}/programs/{program}
documentationUri

string

Apenas saída. O URL de uma página de ajuda do Merchant Center que descreve o programa.
state

enum (State)

Apenas saída. O estado de participação da conta no programa.
activeRegionCodes[]

string

Apenas saída. As regiões em que a conta está participando ativamente do programa. As regiões ativas são aquelas em que todos os requisitos do programa que afetam as regiões foram atendidos.

Os códigos de região são definidos pelo CLDR. O programa pode ser aplicado especificamente a esse país ou 001 quando o programa for globalmente aplicado.
unmetRequirements[]

object (Requirement)

Apenas saída. Os requisitos que a conta ainda não atende e que afetam a participação no programa.

Estado

Possíveis estados de participação no programa da conta.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
NOT_ELIGIBLE A conta não está qualificada para participar do programa.
ELIGIBLE A conta está qualificada para participar do programa.
ENABLED O programa está ativado para a conta.

Requisito

Define um requisito especificado para a participação no programa.

Representação JSON 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Campos
title

string

Apenas saída. Nome do requisito.
documentationUri

string

Apenas saída. O URL de uma página de ajuda que descreve o requisito.
affectedRegionCodes[]

string

Apenas saída. As regiões afetadas atualmente por esse requisito não estão sendo atendidas.

Os códigos de região são definidos pelo CLDR. O programa pode ser aplicado especificamente a esse país ou 001 quando o programa for globalmente aplicado.

Métodos

disable

 Desativa a participação no programa especificado para a conta.

enable

 Ativa a participação no programa especificado para a conta.

get

 Recupera o programa especificado para a conta.

list

 Recupera todos os programas da conta.