REST Resource: accounts.programs

Risorsa: Programma

Definisce la partecipazione a un determinato programma per l'account specificato.

I programmi forniscono un meccanismo per aggiungere funzionalità agli account commerciante. Un tipico esempio è il programma Schede di prodotto senza costi, che consente di mostrare i prodotti del negozio di un commerciante senza costi su Google.

Rappresentazione JSON
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Campi
name

string

Identificatore. Il nome della risorsa del programma. Formato: accounts/{account}/programs/{program}

documentationUri

string

Solo output. L'URL di una pagina di assistenza di Merchant Center che descrive il programma.

state

enum (State)

Solo output. Lo stato di partecipazione dell'account al programma.

activeRegionCodes[]

string

Solo output. Le regioni in cui l'account partecipa attivamente al programma. Le regioni attive sono quelle in cui sono stati soddisfatti tutti i requisiti del programma che le interessano.

I codici regione sono definiti da CLDR. Può essere un paese in cui il programma si applica specificamente a quel paese o 001 se il programma si applica a livello globale.

unmetRequirements[]

object (Requirement)

Solo output. I requisiti che l'account non ha ancora soddisfatto e che influiscono sulla partecipazione al programma.

Stato

Possibili stati di partecipazione al programma per l'account.

Enum
STATE_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
NOT_ELIGIBLE L'account non è idoneo a partecipare al programma.
ELIGIBLE L'account è idoneo a partecipare al programma.
ENABLED Il programma è abilitato per l'account.

Requisito

Definisce un requisito specificato per la partecipazione al programma.

Rappresentazione JSON
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Campi
title

string

Solo output. Nome del requisito.

documentationUri

string

Solo output. L'URL di una pagina di assistenza che descrive il requisito.

affectedRegionCodes[]

string

Solo output. Le regioni attualmente interessate dal mancato rispetto di questo requisito.

I codici regione sono definiti da CLDR. Può essere un paese in cui il programma si applica specificamente a quel paese o 001 se il programma si applica a livello globale.

Metodi

disable

Disattivare la partecipazione al programma specificato per l'account.

enable

Attivare la partecipazione al programma specificato per l'account.

get

Recupera il programma specificato per l'account.

list

Recupera tutti i programmi per l'account.