Interface CheckoutSettingsOrBuilder (1.16.0) 

public interface CheckoutSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEffectiveEnrollmentState()

public abstract 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.v1.CheckoutSettings.CheckoutEnrollmentState effective_enrollment_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CheckoutSettings.CheckoutEnrollmentState

The effectiveEnrollmentState.

getEffectiveEnrollmentStateValue()

public abstract 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.v1.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 abstract 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.v1.CheckoutSettings.CheckoutReviewState effective_review_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CheckoutSettings.CheckoutReviewState

The effectiveReviewState.

getEffectiveReviewStateValue()

public abstract 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.v1.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 abstract 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.v1.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UriSettings

The effectiveUriSettings.

getEffectiveUriSettingsOrBuilder()

public abstract 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.v1.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UriSettingsOrBuilder

getEligibleDestinations(int index)

public abstract Destination.DestinationEnum getEligibleDestinations(int index)

Optional. Required for the create operation. The destinations (also known as Marketing methods) to which the checkout program applies. Valid destination values are SHOPPING_ADS and 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.

getEligibleDestinationsCount()

public abstract int getEligibleDestinationsCount()

Optional. Required for the create operation. The destinations (also known as Marketing methods) to which the checkout program applies. Valid destination values are SHOPPING_ADS and 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 abstract List<Destination.DestinationEnum> getEligibleDestinationsList()

Optional. Required for the create operation. The destinations (also known as Marketing methods) to which the checkout program applies. Valid destination values are SHOPPING_ADS and 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 abstract int getEligibleDestinationsValue(int index)

Optional. Required for the create operation. The destinations (also known as Marketing methods) to which the checkout program applies. Valid destination values are SHOPPING_ADS and 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.

getEligibleDestinationsValueList()

public abstract List<Integer> getEligibleDestinationsValueList()

Optional. Required for the create operation. The destinations (also known as Marketing methods) to which the checkout program applies. Valid destination values are SHOPPING_ADS and 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 abstract CheckoutSettings.CheckoutEnrollmentState getEnrollmentState()

Output only. Reflects the merchant enrollment state in Checkout program.

optional .google.shopping.merchant.accounts.v1.CheckoutSettings.CheckoutEnrollmentState enrollment_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CheckoutSettings.CheckoutEnrollmentState

The enrollmentState.

getEnrollmentStateValue()

public abstract int getEnrollmentStateValue()

Output only. Reflects the merchant enrollment state in Checkout program.

optional .google.shopping.merchant.accounts.v1.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 abstract 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 abstract 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 abstract 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.v1.CheckoutSettings.CheckoutReviewState review_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CheckoutSettings.CheckoutReviewState

The reviewState.

getReviewStateValue()

public abstract 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.v1.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 abstract UriSettings getUriSettings()

URI settings for cart or checkout URL.

optional .google.shopping.merchant.accounts.v1.UriSettings uri_settings = 2;

Returns
Type Description
UriSettings

The uriSettings.

getUriSettingsOrBuilder()

public abstract UriSettingsOrBuilder getUriSettingsOrBuilder()

URI settings for cart or checkout URL.

optional .google.shopping.merchant.accounts.v1.UriSettings uri_settings = 2;

Returns
Type Description
UriSettingsOrBuilder

hasEffectiveEnrollmentState()

public abstract 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.v1.CheckoutSettings.CheckoutEnrollmentState effective_enrollment_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the effectiveEnrollmentState field is set.

hasEffectiveReviewState()

public abstract 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.v1.CheckoutSettings.CheckoutReviewState effective_review_state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the effectiveReviewState field is set.

hasEffectiveUriSettings()

public abstract 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.v1.UriSettings effective_uri_settings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the effectiveUriSettings field is set.

hasEnrollmentState()

public abstract boolean hasEnrollmentState()

Output only. Reflects the merchant enrollment state in Checkout program.

optional .google.shopping.merchant.accounts.v1.CheckoutSettings.CheckoutEnrollmentState enrollment_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the enrollmentState field is set.

hasReviewState()

public abstract 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.v1.CheckoutSettings.CheckoutReviewState review_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the reviewState field is set.

hasUriSettings()

public abstract boolean hasUriSettings()

URI settings for cart or checkout URL.

optional .google.shopping.merchant.accounts.v1.UriSettings uri_settings = 2;

Returns
Type Description
boolean

Whether the uriSettings field is set.