Interface OnlineReturnPolicyOrBuilder (0.9.0) 

public interface OnlineReturnPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAcceptDefectiveOnly()

public abstract boolean getAcceptDefectiveOnly()

This field specifies if merchant only accepts defective products for returns, and this field is required.

optional bool accept_defective_only = 11;

Returns
Type Description
boolean

The acceptDefectiveOnly.

getAcceptExchange()

public abstract boolean getAcceptExchange()

This field specifies if merchant allows customers to exchange products, this field is required.

optional bool accept_exchange = 13;

Returns
Type Description
boolean

The acceptExchange.

getCountries(int index)

public abstract String getCountries(int index)

The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.

repeated string countries = 4;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The countries at the given index.

getCountriesBytes(int index)

public abstract ByteString getCountriesBytes(int index)

The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.

repeated string countries = 4;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the countries at the given index.

getCountriesCount()

public abstract int getCountriesCount()

The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.

repeated string countries = 4;

Returns
Type Description
int

The count of countries.

getCountriesList()

public abstract List<String> getCountriesList()

The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code.

repeated string countries = 4;

Returns
Type Description
List<String>

A list containing the countries.

getItemConditions(int index)

public abstract OnlineReturnPolicy.ItemCondition getItemConditions(int index)

The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ItemCondition item_conditions = 8;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
OnlineReturnPolicy.ItemCondition

The itemConditions at the given index.

getItemConditionsCount()

public abstract int getItemConditionsCount()

The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ItemCondition item_conditions = 8;

Returns
Type Description
int

The count of itemConditions.

getItemConditionsList()

public abstract List<OnlineReturnPolicy.ItemCondition> getItemConditionsList()

The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ItemCondition item_conditions = 8;

Returns
Type Description
List<ItemCondition>

A list containing the itemConditions.

getItemConditionsValue(int index)

public abstract int getItemConditionsValue(int index)

The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ItemCondition item_conditions = 8;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of itemConditions at the given index.

getItemConditionsValueList()

public abstract List<Integer> getItemConditionsValueList()

The item conditions accepted for returns must not be empty unless the type of return policy is 'noReturns'.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ItemCondition item_conditions = 8;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for itemConditions.

getLabel()

public abstract String getLabel()

This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the Return policy label. The label can contain up to 50 characters.

string label = 3;

Returns
Type Description
String

The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

This field represents the unique user-defined label of the return policy. It is important to note that the same label cannot be used in different return policies for the same country. Unless a product specifies a specific label attribute, policies will be automatically labeled as 'default'. To assign a custom return policy to certain product groups, follow the instructions provided in the Return policy label. The label can contain up to 50 characters.

string label = 3;

Returns
Type Description
ByteString

The bytes for label.

getName()

public abstract String getName()

Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of the OnlineReturnPolicy resource. Format: accounts/{account}/onlineReturnPolicies/{return_policy}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPolicy()

public abstract OnlineReturnPolicy.Policy getPolicy()

The return policy.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.Policy policy = 5;

Returns
Type Description
OnlineReturnPolicy.Policy

The policy.

getPolicyOrBuilder()

public abstract OnlineReturnPolicy.PolicyOrBuilder getPolicyOrBuilder()

The return policy.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.Policy policy = 5;

Returns
Type Description
OnlineReturnPolicy.PolicyOrBuilder

getProcessRefundDays()

public abstract int getProcessRefundDays()

The field specifies the number of days it takes for merchants to process refunds, field is optional.

optional int32 process_refund_days = 12;

Returns
Type Description
int

The processRefundDays.

getRestockingFee()

public abstract OnlineReturnPolicy.RestockingFee getRestockingFee()

The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.RestockingFee restocking_fee = 6;

Returns
Type Description
OnlineReturnPolicy.RestockingFee

The restockingFee.

getRestockingFeeOrBuilder()

public abstract OnlineReturnPolicy.RestockingFeeOrBuilder getRestockingFeeOrBuilder()

The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.RestockingFee restocking_fee = 6;

Returns
Type Description
OnlineReturnPolicy.RestockingFeeOrBuilder

getReturnMethods(int index)

public abstract OnlineReturnPolicy.ReturnMethod getReturnMethods(int index)

The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnMethod return_methods = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
OnlineReturnPolicy.ReturnMethod

The returnMethods at the given index.

getReturnMethodsCount()

public abstract int getReturnMethodsCount()

The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnMethod return_methods = 7;

Returns
Type Description
int

The count of returnMethods.

getReturnMethodsList()

public abstract List<OnlineReturnPolicy.ReturnMethod> getReturnMethodsList()

The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnMethod return_methods = 7;

Returns
Type Description
List<ReturnMethod>

A list containing the returnMethods.

getReturnMethodsValue(int index)

public abstract int getReturnMethodsValue(int index)

The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnMethod return_methods = 7;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of returnMethods at the given index.

getReturnMethodsValueList()

public abstract List<Integer> getReturnMethodsValueList()

The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.

repeated .google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnMethod return_methods = 7;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for returnMethods.

getReturnPolicyId()

public abstract String getReturnPolicyId()

Output only. Return policy ID generated by Google.

string return_policy_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The returnPolicyId.

getReturnPolicyIdBytes()

public abstract ByteString getReturnPolicyIdBytes()

Output only. Return policy ID generated by Google.

string return_policy_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for returnPolicyId.

getReturnPolicyUri()

public abstract String getReturnPolicyUri()

The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.

string return_policy_uri = 10;

Returns
Type Description
String

The returnPolicyUri.

getReturnPolicyUriBytes()

public abstract ByteString getReturnPolicyUriBytes()

The return policy uri. This can used by Google to do a sanity check for the policy. It must be a valid URL.

string return_policy_uri = 10;

Returns
Type Description
ByteString

The bytes for returnPolicyUri.

getReturnShippingFee()

public abstract OnlineReturnPolicy.ReturnShippingFee getReturnShippingFee()

The return shipping fee. Should be set only when customer need to download and print the return label.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnShippingFee return_shipping_fee = 9;

Returns
Type Description
OnlineReturnPolicy.ReturnShippingFee

The returnShippingFee.

getReturnShippingFeeOrBuilder()

public abstract OnlineReturnPolicy.ReturnShippingFeeOrBuilder getReturnShippingFeeOrBuilder()

The return shipping fee. Should be set only when customer need to download and print the return label.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnShippingFee return_shipping_fee = 9;

Returns
Type Description
OnlineReturnPolicy.ReturnShippingFeeOrBuilder

hasAcceptDefectiveOnly()

public abstract boolean hasAcceptDefectiveOnly()

This field specifies if merchant only accepts defective products for returns, and this field is required.

optional bool accept_defective_only = 11;

Returns
Type Description
boolean

Whether the acceptDefectiveOnly field is set.

hasAcceptExchange()

public abstract boolean hasAcceptExchange()

This field specifies if merchant allows customers to exchange products, this field is required.

optional bool accept_exchange = 13;

Returns
Type Description
boolean

Whether the acceptExchange field is set.

hasPolicy()

public abstract boolean hasPolicy()

The return policy.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.Policy policy = 5;

Returns
Type Description
boolean

Whether the policy field is set.

hasProcessRefundDays()

public abstract boolean hasProcessRefundDays()

The field specifies the number of days it takes for merchants to process refunds, field is optional.

optional int32 process_refund_days = 12;

Returns
Type Description
boolean

Whether the processRefundDays field is set.

hasRestockingFee()

public abstract boolean hasRestockingFee()

The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.RestockingFee restocking_fee = 6;

Returns
Type Description
boolean

Whether the restockingFee field is set.

hasReturnShippingFee()

public abstract boolean hasReturnShippingFee()

The return shipping fee. Should be set only when customer need to download and print the return label.

.google.shopping.merchant.accounts.v1beta.OnlineReturnPolicy.ReturnShippingFee return_shipping_fee = 9;

Returns
Type Description
boolean

Whether the returnShippingFee field is set.