Show / Hide Table of Contents

Class 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
Inheritance
object
Program
Implements
IMessage<Program>
IEquatable<Program>
IDeepCloneable<Program>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.V1.dll
Syntax
public sealed class Program : IMessage<Program>, IEquatable<Program>, IDeepCloneable<Program>, IBufferMessage, IMessage

Constructors

Program()

Declaration
public Program()

Program(Program)

Declaration
public Program(Program other)
Parameters
Type Name Description
Program other

Properties

ActiveRegionCodes

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.

Declaration
public RepeatedField<string> ActiveRegionCodes { get; }
Property Value
Type Description
RepeatedField<string>

DocumentationUri

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

Declaration
public string DocumentationUri { get; set; }
Property Value
Type Description
string

Name

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

Declaration
public string Name { get; set; }
Property Value
Type Description
string

ProgramName

ProgramName-typed view over the Name resource name property.

Declaration
public ProgramName ProgramName { get; set; }
Property Value
Type Description
ProgramName

State

Output only. The participation state of the account in the program.

Declaration
public Program.Types.State State { get; set; }
Property Value
Type Description
Program.Types.State

UnmetRequirements

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

Declaration
public RepeatedField<Program.Types.Requirement> UnmetRequirements { get; }
Property Value
Type Description
RepeatedField<Program.Types.Requirement>
In this article
Back to top Generated by DocFX