REST Resource: accounts.programs

資源:計畫

定義指定帳戶的特定計畫。

計畫提供為商家帳戶新增功能的機制。常見的例子是「免費產品資訊」計畫,這項計畫可讓商家商店的產品免費在 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

擷取帳戶的所有計畫。