public static final class CheckoutSettings.Builder extends GeneratedMessageV3.Builder<CheckoutSettings.Builder> implements CheckoutSettingsOrBuilderCheckoutSettings for a specific merchant.
Protobuf type google.shopping.merchant.accounts.v1beta.CheckoutSettings
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CheckoutSettings.BuilderImplements
CheckoutSettingsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEligibleDestinations(Iterable<? extends Destination.DestinationEnum> values)
public CheckoutSettings.Builder addAllEligibleDestinations(Iterable<? extends Destination.DestinationEnum> values) 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 |
values |
Iterable<? extends com.google.shopping.type.Destination.DestinationEnum>The eligibleDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
addAllEligibleDestinationsValue(Iterable<Integer> values)
public CheckoutSettings.Builder addAllEligibleDestinationsValue(Iterable<Integer> values) 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 |
values |
Iterable<Integer>The enum numeric values on the wire for eligibleDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
addEligibleDestinations(Destination.DestinationEnum value)
public CheckoutSettings.Builder addEligibleDestinations(Destination.DestinationEnum value) 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 |
value |
com.google.shopping.type.Destination.DestinationEnumThe eligibleDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
addEligibleDestinationsValue(int value)
public CheckoutSettings.Builder addEligibleDestinationsValue(int value) 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 |
value |
intThe enum numeric value on the wire for eligibleDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CheckoutSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
build()
public CheckoutSettings build()| Returns | |
|---|---|
| Type | Description |
CheckoutSettings |
|
buildPartial()
public CheckoutSettings buildPartial()| Returns | |
|---|---|
| Type | Description |
CheckoutSettings |
|
clear()
public CheckoutSettings.Builder clear()| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
clearEffectiveEnrollmentState()
public CheckoutSettings.Builder clearEffectiveEnrollmentState()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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearEffectiveReviewState()
public CheckoutSettings.Builder clearEffectiveReviewState() 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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearEffectiveUriSettings()
public CheckoutSettings.Builder clearEffectiveUriSettings() 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 |
CheckoutSettings.Builder |
|
clearEligibleDestinations()
public CheckoutSettings.Builder clearEligibleDestinations() 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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearEnrollmentState()
public CheckoutSettings.Builder clearEnrollmentState() 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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CheckoutSettings.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
clearName()
public CheckoutSettings.Builder clearName() 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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CheckoutSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
clearReviewState()
public CheckoutSettings.Builder clearReviewState() 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 |
CheckoutSettings.Builder |
This builder for chaining. |
clearUriSettings()
public CheckoutSettings.Builder clearUriSettings()URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
clone()
public CheckoutSettings.Builder clone()| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
getDefaultInstanceForType()
public CheckoutSettings getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CheckoutSettings |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEffectiveEnrollmentState()
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];
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.CheckoutEnrollmentState |
The effectiveEnrollmentState. |
getEffectiveEnrollmentStateValue()
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. |
getEffectiveReviewState()
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];
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.CheckoutReviewState |
The effectiveReviewState. |
getEffectiveReviewStateValue()
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. |
getEffectiveUriSettings()
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. |
getEffectiveUriSettingsBuilder()
public UriSettings.Builder getEffectiveUriSettingsBuilder() 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.Builder |
|
getEffectiveUriSettingsOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
UriSettingsOrBuilder |
|
getEligibleDestinations(int index)
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Destination.DestinationEnum |
The eligibleDestinations at the given index. |
getEligibleDestinationsCount()
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. |
getEligibleDestinationsList()
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. |
getEligibleDestinationsValue(int index)
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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of eligibleDestinations at the given index. |
getEligibleDestinationsValueList()
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. |
getEnrollmentState()
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];
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.CheckoutEnrollmentState |
The enrollmentState. |
getEnrollmentStateValue()
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. |
getName()
public String getName() 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. |
getNameBytes()
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. |
getReviewState()
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];
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.CheckoutReviewState |
The reviewState. |
getReviewStateValue()
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. |
getUriSettings()
public UriSettings getUriSettings()URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Returns | |
|---|---|
| Type | Description |
UriSettings |
The uriSettings. |
getUriSettingsBuilder()
public UriSettings.Builder getUriSettingsBuilder()URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Returns | |
|---|---|
| Type | Description |
UriSettings.Builder |
|
getUriSettingsOrBuilder()
public UriSettingsOrBuilder getUriSettingsOrBuilder()URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Returns | |
|---|---|
| Type | Description |
UriSettingsOrBuilder |
|
hasEffectiveEnrollmentState()
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. |
hasEffectiveReviewState()
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. |
hasEffectiveUriSettings()
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. |
hasEnrollmentState()
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. |
hasReviewState()
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. |
hasUriSettings()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEffectiveUriSettings(UriSettings value)
public CheckoutSettings.Builder mergeEffectiveUriSettings(UriSettings value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
UriSettings |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CheckoutSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CheckoutSettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
mergeFrom(CheckoutSettings other)
public CheckoutSettings.Builder mergeFrom(CheckoutSettings other)| Parameter | |
|---|---|
| Name | Description |
other |
CheckoutSettings |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CheckoutSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
mergeUriSettings(UriSettings value)
public CheckoutSettings.Builder mergeUriSettings(UriSettings value)URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
UriSettings |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setEffectiveEnrollmentState(CheckoutSettings.CheckoutEnrollmentState value)
public CheckoutSettings.Builder setEffectiveEnrollmentState(CheckoutSettings.CheckoutEnrollmentState value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
CheckoutSettings.CheckoutEnrollmentStateThe effectiveEnrollmentState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEffectiveEnrollmentStateValue(int value)
public CheckoutSettings.Builder setEffectiveEnrollmentStateValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for effectiveEnrollmentState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEffectiveReviewState(CheckoutSettings.CheckoutReviewState value)
public CheckoutSettings.Builder setEffectiveReviewState(CheckoutSettings.CheckoutReviewState value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CheckoutSettings.CheckoutReviewStateThe effectiveReviewState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEffectiveReviewStateValue(int value)
public CheckoutSettings.Builder setEffectiveReviewStateValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for effectiveReviewState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEffectiveUriSettings(UriSettings value)
public CheckoutSettings.Builder setEffectiveUriSettings(UriSettings value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
UriSettings |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setEffectiveUriSettings(UriSettings.Builder builderForValue)
public CheckoutSettings.Builder setEffectiveUriSettings(UriSettings.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UriSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setEligibleDestinations(int index, Destination.DestinationEnum value)
public CheckoutSettings.Builder setEligibleDestinations(int index, Destination.DestinationEnum value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
com.google.shopping.type.Destination.DestinationEnumThe eligibleDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEligibleDestinationsValue(int index, int value)
public CheckoutSettings.Builder setEligibleDestinationsValue(int index, int value) 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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for eligibleDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEnrollmentState(CheckoutSettings.CheckoutEnrollmentState value)
public CheckoutSettings.Builder setEnrollmentState(CheckoutSettings.CheckoutEnrollmentState value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CheckoutSettings.CheckoutEnrollmentStateThe enrollmentState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setEnrollmentStateValue(int value)
public CheckoutSettings.Builder setEnrollmentStateValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for enrollmentState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CheckoutSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setName(String value)
public CheckoutSettings.Builder setName(String value) Identifier. The resource name of the program configuration settings.
Format: accounts/{account}/programs/{program}/checkoutSettings
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public CheckoutSettings.Builder setNameBytes(ByteString value) Identifier. The resource name of the program configuration settings.
Format: accounts/{account}/programs/{program}/checkoutSettings
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CheckoutSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setReviewState(CheckoutSettings.CheckoutReviewState value)
public CheckoutSettings.Builder setReviewState(CheckoutSettings.CheckoutReviewState value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
CheckoutSettings.CheckoutReviewStateThe reviewState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setReviewStateValue(int value)
public CheckoutSettings.Builder setReviewStateValue(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for reviewState to set. |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CheckoutSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setUriSettings(UriSettings value)
public CheckoutSettings.Builder setUriSettings(UriSettings value)URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
UriSettings |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|
setUriSettings(UriSettings.Builder builderForValue)
public CheckoutSettings.Builder setUriSettings(UriSettings.Builder builderForValue)URI settings for cart or checkout URL.
optional .google.shopping.merchant.accounts.v1beta.UriSettings uri_settings = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UriSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
CheckoutSettings.Builder |
|