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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACTIVE_REGION_CODES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DOCUMENTATION_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UNMET_REQUIREMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Program getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Program.Builder newBuilder()
public static Program.Builder newBuilder(Program prototype)
| Parameter |
| Name |
Description |
prototype |
Program
|
public static Program parseDelimitedFrom(InputStream input)
public static Program parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Program parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Program parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Program parseFrom(ByteString data)
public static Program parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Program parseFrom(CodedInputStream input)
public static Program parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Program parseFrom(InputStream input)
public static Program parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Program parseFrom(ByteBuffer data)
public static Program parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Program> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
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.
|
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];
public Program getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
public Parser<Program> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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.
|
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
|
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 |
|
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];
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
|
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> |
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Program.Builder newBuilderForType()
protected Program.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Program.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
