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

检索帐号的所有程序。