REST Resource: accounts.programs

Resource: Program

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the Free product listings program, which enables products from a business's store to be shown across Google for free.

The following list is the available set of program resource IDs accessible through the API:

  • free-listings
  • shopping-ads
  • youtube-shopping-checkout
JSON representation 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
Fields
name

string

Identifier. The resource name of the program. Format: accounts/{account}/programs/{program}
documentationUri

string

Output only. The URL of a Merchant Center help page describing the program.
state

enum (State)

Output only. The participation state of the account in the program.
activeRegionCodes[]

string

Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met.

Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.
unmetRequirements[]

object (Requirement)

Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.

State

Possible program participation states for the account.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
NOT_ELIGIBLE The account is not eligible to participate in the program.
ELIGIBLE The account is eligible to participate in the program.
ENABLED The program is enabled for the account.

Requirement

Defines a requirement specified for participation in the program.

JSON representation 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
Fields
title

string

Output only. Name of the requirement.
documentationUri

string

Output only. The URL of a help page describing the requirement.
affectedRegionCodes[]

string

Output only. The regions that are currently affected by this requirement not being met.

Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.

Methods

disable

 Disable participation in the specified program for the account.

enable

 Enable participation in the specified program for the account.

get

 Retrieves the specified program for the account.

list

 Retrieves all programs for the account.