Class Program (0.5.0)

public final class Program extends GeneratedMessageV3 implements ProgramOrBuilder

Defines participation in a given program for the specified account.

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

Protobuf type google.shopping.merchant.accounts.v1beta.Program

Implements

ProgramOrBuilder

Static Fields

ACTIVE_REGION_CODES_FIELD_NUMBER

public static final int ACTIVE_REGION_CODES_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENTATION_URI_FIELD_NUMBER

public static final int DOCUMENTATION_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UNMET_REQUIREMENTS_FIELD_NUMBER

public static final int UNMET_REQUIREMENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Program getDefaultInstance()
Returns
Type Description
Program

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Program.Builder newBuilder()
Returns
Type Description
Program.Builder

newBuilder(Program prototype)

public static Program.Builder newBuilder(Program prototype)
Parameter
Name Description
prototype Program
Returns
Type Description
Program.Builder

parseDelimitedFrom(InputStream input)

public static Program parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Program parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Program parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Program parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Program parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Program parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Program parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Program parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Program parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Program parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Program parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Program parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Program
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Program> parser()
Returns
Type Description
Parser<Program>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActiveRegionCodes(int index)

public String getActiveRegionCodes(int index)

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.

repeated string active_region_codes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The activeRegionCodes at the given index.

getActiveRegionCodesBytes(int index)

public ByteString getActiveRegionCodesBytes(int index)

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.

repeated string active_region_codes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the activeRegionCodes at the given index.

getActiveRegionCodesCount()

public int getActiveRegionCodesCount()

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.

repeated string active_region_codes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of activeRegionCodes.

getActiveRegionCodesList()

public ProtocolStringList getActiveRegionCodesList()

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.

repeated string active_region_codes = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the activeRegionCodes.

getDefaultInstanceForType()

public Program getDefaultInstanceForType()
Returns
Type Description
Program

getDocumentationUri()

public String getDocumentationUri()

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

string documentation_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The documentationUri.

getDocumentationUriBytes()

public ByteString getDocumentationUriBytes()

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

string documentation_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for documentationUri.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Program> getParserForType()
Returns
Type Description
Parser<Program>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Program.State getState()

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

.google.shopping.merchant.accounts.v1beta.Program.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Program.State

The state.

getStateValue()

public int getStateValue()

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

.google.shopping.merchant.accounts.v1beta.Program.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUnmetRequirements(int index)

public Program.Requirement getUnmetRequirements(int index)

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

repeated .google.shopping.merchant.accounts.v1beta.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Program.Requirement

getUnmetRequirementsCount()

public int getUnmetRequirementsCount()

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

repeated .google.shopping.merchant.accounts.v1beta.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUnmetRequirementsList()

public List<Program.Requirement> getUnmetRequirementsList()

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

repeated .google.shopping.merchant.accounts.v1beta.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Requirement>

getUnmetRequirementsOrBuilder(int index)

public Program.RequirementOrBuilder getUnmetRequirementsOrBuilder(int index)

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

repeated .google.shopping.merchant.accounts.v1beta.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Program.RequirementOrBuilder

getUnmetRequirementsOrBuilderList()

public List<? extends Program.RequirementOrBuilder> getUnmetRequirementsOrBuilderList()

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

repeated .google.shopping.merchant.accounts.v1beta.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.shopping.merchant.accounts.v1beta.Program.RequirementOrBuilder>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Program.Builder newBuilderForType()
Returns
Type Description
Program.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Program.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Program.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Program.Builder toBuilder()
Returns
Type Description
Program.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException