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 ヘルプページの URL。
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

 アカウントのすべてのプログラムを取得します。