REST Resource: accounts.programs

Recurso: programa

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

Os programas oferecem um mecanismo para adicionar funcionalidades às contas do comerciante. Um exemplo típico disso é o programa de listagens de produtos sem custo financeiro, que permite que os produtos da loja de um comerciante sejam mostrados 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 do 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 definidas como aquelas em que todos os requisitos do programa que afetam as regiões foram atendidos.

Os códigos regionais são definidos pelo CLDR. É um país em que o programa se aplica especificamente a esse país ou 001 quando o programa se aplica globalmente.
unmetRequirements[]

object (Requirement)

Apenas saída. Os requisitos que a conta ainda não atendeu e que estão afetando a participação no programa.

Estado

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

Enums
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 que estão sendo afetadas por esse requisito não ser atendido.

Os códigos regionais são definidos pelo CLDR. É um país em que o programa se aplica especificamente a esse país ou 001 quando o programa se aplica globalmente.

Métodos

disable

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

enable

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

get

 Recupera o programa especificado para a conta.

list

 Recupera todos os programas da conta.