public final class CheckoutSettings extends GeneratedMessageV3 implements CheckoutSettingsOrBuilder
CheckoutSettings for
a specific merchant.
Protobuf type google.shopping.merchant.accounts.v1beta.CheckoutSettings
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 EFFECTIVE_ENROLLMENT_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EFFECTIVE_REVIEW_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EFFECTIVE_URI_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ELIGIBLE_DESTINATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ENROLLMENT_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REVIEW_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int URI_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static CheckoutSettings getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static CheckoutSettings.Builder newBuilder()
public static CheckoutSettings.Builder newBuilder(CheckoutSettings prototype)
public static CheckoutSettings parseDelimitedFrom(InputStream input)
public static CheckoutSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CheckoutSettings parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static CheckoutSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CheckoutSettings parseFrom(ByteString data)
public static CheckoutSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CheckoutSettings parseFrom(CodedInputStream input)
public static CheckoutSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CheckoutSettings parseFrom(InputStream input)
public static CheckoutSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CheckoutSettings parseFrom(ByteBuffer data)
public static CheckoutSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<CheckoutSettings> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public CheckoutSettings getDefaultInstanceForType()
public CheckoutSettings.CheckoutEnrollmentState getEffectiveEnrollmentState()
Output only. The effective value of enrollment_state for a given merchant
ID. If account level settings are present then this value will be a copy of
the account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState effective_enrollment_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getEffectiveEnrollmentStateValue()
Output only. The effective value of enrollment_state for a given merchant
ID. If account level settings are present then this value will be a copy of
the account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState effective_enrollment_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for effectiveEnrollmentState.
|
public CheckoutSettings.CheckoutReviewState getEffectiveReviewState()
Output only. The effective value of review_state for a given merchant ID.
If account level settings are present then this value will be a copy of the
account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState effective_review_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getEffectiveReviewStateValue()
Output only. The effective value of review_state for a given merchant ID.
If account level settings are present then this value will be a copy of the
account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState effective_review_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for effectiveReviewState.
|
public UriSettings getEffectiveUriSettings()
Output only. The effective value of uri_settings for a given merchant. If
account level settings are present then this value will be a copy of url
settings. Otherwise, it will have the value of the parent account (for only
marketplace sellers).
.google.shopping.merchant.accounts.v1beta.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
UriSettings |
The effectiveUriSettings.
|
public UriSettingsOrBuilder getEffectiveUriSettingsOrBuilder()
Output only. The effective value of uri_settings for a given merchant. If
account level settings are present then this value will be a copy of url
settings. Otherwise, it will have the value of the parent account (for only
marketplace sellers).
.google.shopping.merchant.accounts.v1beta.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Destination.DestinationEnum getEligibleDestinations(int index)
Optional. The destinations to which the checkout program applies, valid
destination values are SHOPPING_ADS, FREE_LISTINGS
repeated .google.shopping.type.Destination.DestinationEnum eligible_destinations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
com.google.shopping.type.Destination.DestinationEnum |
The eligibleDestinations at the given index.
|
public int getEligibleDestinationsCount()
Optional. The destinations to which the checkout program applies, valid
destination values are SHOPPING_ADS, FREE_LISTINGS
repeated .google.shopping.type.Destination.DestinationEnum eligible_destinations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of eligibleDestinations.
|
public List<Destination.DestinationEnum> getEligibleDestinationsList()
Optional. The destinations to which the checkout program applies, valid
destination values are SHOPPING_ADS, FREE_LISTINGS
repeated .google.shopping.type.Destination.DestinationEnum eligible_destinations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<com.google.shopping.type.Destination.DestinationEnum> |
A list containing the eligibleDestinations.
|
public int getEligibleDestinationsValue(int index)
Optional. The destinations to which the checkout program applies, valid
destination values are SHOPPING_ADS, FREE_LISTINGS
repeated .google.shopping.type.Destination.DestinationEnum eligible_destinations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire of eligibleDestinations at the given index.
|
public List<Integer> getEligibleDestinationsValueList()
Optional. The destinations to which the checkout program applies, valid
destination values are SHOPPING_ADS, FREE_LISTINGS
repeated .google.shopping.type.Destination.DestinationEnum eligible_destinations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for eligibleDestinations.
|
public CheckoutSettings.CheckoutEnrollmentState getEnrollmentState()
Output only. Reflects the merchant enrollment state in Checkout program.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState enrollment_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getEnrollmentStateValue()
Output only. Reflects the merchant enrollment state in Checkout program.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState enrollment_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for enrollmentState.
|
Identifier. The resource name of the program configuration settings.
Format: accounts/{account}/programs/{program}/checkoutSettings
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The resource name of the program configuration settings.
Format: accounts/{account}/programs/{program}/checkoutSettings
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<CheckoutSettings> getParserForType()
Overrides
public CheckoutSettings.CheckoutReviewState getReviewState()
Output only. Reflects the merchant review state in Checkout program.
This is set based on the data quality reviews of the URL provided by
the merchant.
A merchant with enrollment state
as ENROLLED can be in the following review states: IN_REVIEW,
APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of
ENROLLED before a review can begin for the merchant.For more details,
check the help center doc.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState review_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getReviewStateValue()
Output only. Reflects the merchant review state in Checkout program.
This is set based on the data quality reviews of the URL provided by
the merchant.
A merchant with enrollment state
as ENROLLED can be in the following review states: IN_REVIEW,
APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of
ENROLLED before a review can begin for the merchant.For more details,
check the help center doc.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState review_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for reviewState.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public UriSettings getUriSettings()
URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
public UriSettingsOrBuilder getUriSettingsOrBuilder()
URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
public boolean hasEffectiveEnrollmentState()
Output only. The effective value of enrollment_state for a given merchant
ID. If account level settings are present then this value will be a copy of
the account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState effective_enrollment_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the effectiveEnrollmentState field is set.
|
public boolean hasEffectiveReviewState()
Output only. The effective value of review_state for a given merchant ID.
If account level settings are present then this value will be a copy of the
account level settings. Otherwise, it will have the value of the parent
account (for only marketplace sellers).
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState effective_review_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the effectiveReviewState field is set.
|
public boolean hasEffectiveUriSettings()
Output only. The effective value of uri_settings for a given merchant. If
account level settings are present then this value will be a copy of url
settings. Otherwise, it will have the value of the parent account (for only
marketplace sellers).
.google.shopping.merchant.accounts.v1beta.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the effectiveUriSettings field is set.
|
public boolean hasEnrollmentState()
Output only. Reflects the merchant enrollment state in Checkout program.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutEnrollmentState enrollment_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the enrollmentState field is set.
|
public boolean hasReviewState()
Output only. Reflects the merchant review state in Checkout program.
This is set based on the data quality reviews of the URL provided by
the merchant.
A merchant with enrollment state
as ENROLLED can be in the following review states: IN_REVIEW,
APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of
ENROLLED before a review can begin for the merchant.For more details,
check the help center doc.
optional .google.shopping.merchant.accounts.v1beta.CheckoutSettings.CheckoutReviewState review_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the reviewState field is set.
|
public boolean hasUriSettings()
URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Returns |
| Type |
Description |
boolean |
Whether the uriSettings field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public CheckoutSettings.Builder newBuilderForType()
protected CheckoutSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public CheckoutSettings.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
