REST Resource: accounts.programs

資源:Program

定義指定帳戶參與特定計畫的情況。

計畫提供一種機制,可在商家帳戶中新增功能。典型例子就是免費產品資訊計畫,可讓商家商店的產品在 Google 各項服務中免費顯示。

JSON 表示法
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
欄位
name

string

ID。程式的資源名稱。格式: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

擷取帳戶的所有節目。