REST Resource: accounts.programs

Zasób: Program

Określa udział w danym programie na określonym koncie.

Programy stanowią mechanizm umożliwiający dodawanie funkcji do kont sprzedawców. Typowym przykładem jest program bezpłatnych informacji o produktach, 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, na której opisano program.
state

enum (State)

Tylko dane wyjściowe. Stan udziału konta w programie.
activeRegionCodes[]

string

Tylko dane wyjściowe. regiony, w których konto aktywnie uczestniczy w programie; Aktywnymi regionami są te, w których zostały spełnione wszystkie wymagania programu.

Kody regionów są definiowane przez CLDR. Może to być kraj, w którym program jest dostępny, lub 001, jeśli program jest dostępny na całym świecie.
unmetRequirements[]

object (Requirement)

Tylko dane wyjściowe. Wymagania, których konto jeszcze nie spełnia i 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 kwalifikuje się do udziału w programie.
ENABLED Program jest włączony na koncie.

Co musisz zrobić

Określa wymagania dotyczące uczestnictwa w programie.

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

string

Tylko dane wyjściowe. Nazwa wymagań.
documentationUri

string

Tylko dane wyjściowe. Adres URL strony pomocy opisującej wymagania.
affectedRegionCodes[]

string

Tylko dane wyjściowe. Regiony, które są obecnie objęte tym wymogiem.

Kody regionów są definiowane przez CLDR. Może to być kraj, w którym program jest dostępny, lub 001, jeśli program jest dostępny na całym świecie.

Metody

disable

 wyłączyć udział w określonym programie na koncie.

enable

 umożliwić udział w określonym programie na koncie;

get

 Pobiera określony program na koncie.

list

 Pobiera wszystkie programy na koncie.