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

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