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

仅限输出。指向介绍该计划的 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

仅限输出。说明相应要求的帮助页面的网址。
affectedRegionCodes[]

string

仅限输出。目前受此要求不满足影响的地区。

地区代码由 CLDR 定义。如果计划仅适用于某个国家/地区，则填写该国家/地区；如果计划在全球范围内适用，则填写 001。

方法

disable

 禁止账号参与指定计划。

enable

 为账号启用参与指定计划的权限。

get

 检索账号的指定计划。

list

 检索账号的所有计划。