REST Resource: accounts.programs

Zasób: Program

Definiuje udział w danym programie na określonym koncie.

Programy zapewniają mechanizm dodawania funkcji do kont sprzedawców. Typowym przykładem jest program Bezpłatne informacje o produkcie, który umożliwia bezpłatne wyświetlanie produktów ze sklepu sprzedawcy w Google.

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

string

Identyfikator. Nazwa zasobu programu. Format: accounts/{account}/programs/{program}

documentationUri

string

Tylko dane wyjściowe. Adres URL strony pomocy Merchant Center opisującej program.

state

enum (State)

Tylko dane wyjściowe. Stan konta w programie.

activeRegionCodes[]

string

Tylko dane wyjściowe. Regiony, w których konto aktywnie uczestniczy w programie. Aktywne regiony to te, w których spełnione są wszystkie wymagania programu dotyczące regionów.

Kody regionów są definiowane przez CLDR. Wybierz kraj, w którym program dotyczy tylko tego kraju, lub 001, jeśli program obowiązuje na całym świecie.

unmetRequirements[]

object (Requirement)

Tylko dane wyjściowe. Wymagania, które nie zostały jeszcze spełnione na koncie, które mają wpływ na udział w programie.

Stan

Możliwe stany udziału w programie na koncie.

Wartości w polu enum
STATE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
NOT_ELIGIBLE Konto nie kwalifikuje się do udziału w programie.
ELIGIBLE Konto może brać udział w programie.
ENABLED Program jest włączony na koncie.

Co musisz zrobić

Definiuje wymagania określone dla uczestnictwa w programie.

Zapis JSON
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Pola
title

string

Tylko dane wyjściowe. Nazwa wymagania.

documentationUri

string

Tylko dane wyjściowe. Adres URL strony pomocy opisującej wymaganie.

affectedRegionCodes[]

string

Tylko dane wyjściowe. Regiony, których dotyczy to wymaganie, nie są obecnie spełnione.

Kody regionów są definiowane przez CLDR. Wybierz kraj, w którym program dotyczy tylko tego kraju, lub 001, jeśli program obowiązuje na całym świecie.

Metody

disable

Wyłącz na koncie udział w określonym programie.

enable

Włącz na koncie udział w określonym programie.

get

Pobiera określony program dla konta.

list

Pobiera wszystkie programy na koncie.