Interface ProgramOrBuilder (1.0.0) 

public interface ProgramOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActiveRegionCodes(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the activeRegionCodes.

getDocumentationUri()

public abstract 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 abstract 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 abstract 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 abstract 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.

getState()

public abstract Program.State getState()

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

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

Returns
Type Description
Program.State

The state.

getStateValue()

public abstract int getStateValue()

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

.google.shopping.merchant.accounts.v1.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 abstract 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.v1.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Program.Requirement

getUnmetRequirementsCount()

public abstract 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.v1.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUnmetRequirementsList()

public abstract 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.v1.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Requirement>

getUnmetRequirementsOrBuilder(int index)

public abstract 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.v1.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Program.RequirementOrBuilder

getUnmetRequirementsOrBuilderList()

public abstract 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.v1.Program.Requirement unmet_requirements = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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