Interface ProgramOrBuilder (0.5.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.v1beta.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.v1beta.Program.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for state.