REST Resource: accounts.programs

Ресурс: Программа

Определяет участие в данной программе для указанного аккаунта.

Программы предоставляют механизм добавления функциональности к торговым счетам. Типичным примером этого является программа бесплатных списков товаров , которая позволяет бесплатно показывать товары из магазина продавца в Google.

JSON-представление
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Поля
name

string

Идентификатор. Имя ресурса программы. Формат: accounts/{account}/programs/{program}

documentationUri

string

Только вывод. URL-адрес страницы справки Merchant Center с описанием программы.

state

enum ( State )

Только вывод. Статус участия аккаунта в программе.

activeRegionCodes[]

string

Только вывод. Регионы, в которых аккаунт активно участвует в программе. Активные регионы определяются как регионы, в которых все требования программы, затрагивающие регионы, выполнены.

Коды регионов определяются CLDR . Это либо страна, в которой программа применяется конкретно к этой стране, либо 001 , когда программа применяется во всем мире.

unmetRequirements[]

object ( Requirement )

Только вывод. Требования, которым еще не удовлетворен аккаунт, влияющие на участие в программе.

Состояние

Возможные состояния участия в программе для аккаунта.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
NOT_ELIGIBLE Аккаунт не имеет права участвовать в программе.
ELIGIBLE Аккаунт имеет право на участие в программе.
ENABLED Программа включена для учетной записи.

Требование

Определяет требование, предъявляемое для участия в программе.

JSON-представление
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Поля
title

string

Только вывод. Название требования.

documentationUri

string

Только вывод. URL-адрес страницы справки, описывающей требование.

affectedRegionCodes[]

string

Только вывод. В регионах, на которые в настоящее время распространяется это требование, не выполняется.

Коды регионов определяются CLDR . Это либо страна, в которой программа применяется конкретно к этой стране, либо 001 , когда программа применяется во всем мире.

Методы

disable

 Отключить участие в указанной программе для аккаунта.

enable

 Разрешить участие в указанной программе для аккаунта.

get

 Извлекает указанную программу для учетной записи.

list

 Получает все программы для учетной записи.