public final class TermsOfServiceAgreementState extends GeneratedMessageV3 implements TermsOfServiceAgreementStateOrBuilder
This resource represents the agreement state for a given account and terms of
service kind.
The state is as follows:
- If the merchant has accepted a terms of service:
accepted will be populated,
otherwise it will be empty
If the merchant must sign a terms of service:
required will be populated,
otherwise it will be empty.
Note that both required and
accepted can be present. In this
case the accepted
terms of services will have an expiration date set in the
valid_until field. The required
terms of services
need to be accepted before valid_until
in order for the account to continue
having a valid agreement. When accepting new terms of services we expect 3Ps
to display the text associated with the given terms of service agreement (the
url to the file containing the text is added in the Required message below as
tos_file_uri. The actual acceptance of the terms of
service is done by calling accept on the TermsOfService
resource.
Protobuf type google.shopping.merchant.accounts.v1beta.TermsOfServiceAgreementState
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 ACCEPTED_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int REGION_CODE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int REQUIRED_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int TERMS_OF_SERVICE_KIND_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static TermsOfServiceAgreementState getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static TermsOfServiceAgreementState.Builder newBuilder()
public static TermsOfServiceAgreementState.Builder newBuilder(TermsOfServiceAgreementState prototype)
public static TermsOfServiceAgreementState parseDelimitedFrom(InputStream input)
public static TermsOfServiceAgreementState parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TermsOfServiceAgreementState parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static TermsOfServiceAgreementState parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TermsOfServiceAgreementState parseFrom(ByteString data)
public static TermsOfServiceAgreementState parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TermsOfServiceAgreementState parseFrom(CodedInputStream input)
public static TermsOfServiceAgreementState parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TermsOfServiceAgreementState parseFrom(InputStream input)
public static TermsOfServiceAgreementState parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static TermsOfServiceAgreementState parseFrom(ByteBuffer data)
public static TermsOfServiceAgreementState parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<TermsOfServiceAgreementState> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
public Accepted getAccepted()
The accepted terms of service of this kind and for the associated
region_code
optional .google.shopping.merchant.accounts.v1beta.Accepted accepted = 4;
Returns |
Type |
Description |
Accepted |
The accepted.
|
public AcceptedOrBuilder getAcceptedOrBuilder()
The accepted terms of service of this kind and for the associated
region_code
optional .google.shopping.merchant.accounts.v1beta.Accepted accepted = 4;
public TermsOfServiceAgreementState getDefaultInstanceForType()
Identifier. The resource name of the terms of service version.
Format: accounts/{account}/termsOfServiceAgreementState/{identifier}
The identifier format is: {TermsOfServiceKind}-{country}
For example, an identifier could be: MERCHANT_CENTER-US
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns |
Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The resource name of the terms of service version.
Format: accounts/{account}/termsOfServiceAgreementState/{identifier}
The identifier format is: {TermsOfServiceKind}-{country}
For example, an identifier could be: MERCHANT_CENTER-US
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns |
Type |
Description |
ByteString |
The bytes for name.
|
public Parser<TermsOfServiceAgreementState> getParserForType()
Overrides
public String getRegionCode()
Region code as defined by https://cldr.unicode.org/. This is the
country the current state applies to.
string region_code = 2;
Returns |
Type |
Description |
String |
The regionCode.
|
public ByteString getRegionCodeBytes()
Region code as defined by https://cldr.unicode.org/. This is the
country the current state applies to.
string region_code = 2;
Returns |
Type |
Description |
ByteString |
The bytes for regionCode.
|
public Required getRequired()
The required terms of service
optional .google.shopping.merchant.accounts.v1beta.Required required = 5;
Returns |
Type |
Description |
Required |
The required.
|
public RequiredOrBuilder getRequiredOrBuilder()
The required terms of service
optional .google.shopping.merchant.accounts.v1beta.Required required = 5;
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
public TermsOfServiceKind getTermsOfServiceKind()
Terms of Service kind associated with the particular version.
.google.shopping.merchant.accounts.v1beta.TermsOfServiceKind terms_of_service_kind = 3;
public int getTermsOfServiceKindValue()
Terms of Service kind associated with the particular version.
.google.shopping.merchant.accounts.v1beta.TermsOfServiceKind terms_of_service_kind = 3;
Returns |
Type |
Description |
int |
The enum numeric value on the wire for termsOfServiceKind.
|
public boolean hasAccepted()
The accepted terms of service of this kind and for the associated
region_code
optional .google.shopping.merchant.accounts.v1beta.Accepted accepted = 4;
Returns |
Type |
Description |
boolean |
Whether the accepted field is set.
|
public boolean hasRequired()
The required terms of service
optional .google.shopping.merchant.accounts.v1beta.Required required = 5;
Returns |
Type |
Description |
boolean |
Whether the required field is set.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public TermsOfServiceAgreementState.Builder newBuilderForType()
protected TermsOfServiceAgreementState.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public TermsOfServiceAgreementState.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides