com.google.api.services.content.model

Class Service

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.content.model.Service

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Service
extends com.google.api.client.json.GenericJson

Model definition for Service.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Content API for Shopping. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Modifier and Type	Method and Description
Service	clone()
Boolean	getActive() A boolean exposing the active status of the shipping service.
String	getCurrency() The CLDR code of the currency to which this service applies.
String	getDeliveryCountry() The CLDR territory code of the country to which the service applies.
DeliveryTime	getDeliveryTime() Time spent in various aspects from order to the delivery of the product.
String	getEligibility() Eligibility for this service.
Price	getMinimumOrderValue() Minimum order value for this service.
MinimumOrderValueTable	getMinimumOrderValueTable() Table of per store minimum order values for the pickup fulfillment type.
String	getName() Free-form name of the service.
PickupCarrierService	getPickupService() The carrier-service pair delivering items to collection points.
List<RateGroup>	getRateGroups() Shipping rate group definitions.
String	getShipmentType() Type of locations this service ships orders to.
ServiceStoreConfig	getStoreConfig() A list of stores your products are delivered from.
Service	set(String fieldName, Object value)
Service	setActive(Boolean active) A boolean exposing the active status of the shipping service.
Service	setCurrency(String currency) The CLDR code of the currency to which this service applies.
Service	setDeliveryCountry(String deliveryCountry) The CLDR territory code of the country to which the service applies.
Service	setDeliveryTime(DeliveryTime deliveryTime) Time spent in various aspects from order to the delivery of the product.
Service	setEligibility(String eligibility) Eligibility for this service.
Service	setMinimumOrderValue(Price minimumOrderValue) Minimum order value for this service.
Service	setMinimumOrderValueTable(MinimumOrderValueTable minimumOrderValueTable) Table of per store minimum order values for the pickup fulfillment type.
Service	setName(String name) Free-form name of the service.
Service	setPickupService(PickupCarrierService pickupService) The carrier-service pair delivering items to collection points.
Service	setRateGroups(List<RateGroup> rateGroups) Shipping rate group definitions.
Service	setShipmentType(String shipmentType) Type of locations this service ships orders to.
Service	setStoreConfig(ServiceStoreConfig storeConfig) A list of stores your products are delivered from.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Service

public Service()

Method Detail

getActive

public Boolean getActive()

A boolean exposing the active status of the shipping service. Required.

Returns:

value or null for none

setActive

public Service setActive(Boolean active)

A boolean exposing the active status of the shipping service. Required.

Parameters:

active - active or null for none

getCurrency

public String getCurrency()

The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.

Returns:

value or null for none

setCurrency

public Service setCurrency(String currency)

The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.

Parameters:

currency - currency or null for none

getDeliveryCountry

public String getDeliveryCountry()

The CLDR territory code of the country to which the service applies. Required.

Returns:

value or null for none

setDeliveryCountry

public Service setDeliveryCountry(String deliveryCountry)

The CLDR territory code of the country to which the service applies. Required.

Parameters:

deliveryCountry - deliveryCountry or null for none

getDeliveryTime

public DeliveryTime getDeliveryTime()

Time spent in various aspects from order to the delivery of the product. Required.

Returns:

value or null for none

setDeliveryTime

public Service setDeliveryTime(DeliveryTime deliveryTime)

Time spent in various aspects from order to the delivery of the product. Required.

Parameters:

deliveryTime - deliveryTime or null for none

getEligibility

public String getEligibility()

Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"

Returns:

value or null for none

setEligibility

public Service setEligibility(String eligibility)

Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`"

Parameters:

eligibility - eligibility or null for none

getMinimumOrderValue

public Price getMinimumOrderValue()

Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.

Returns:

value or null for none

setMinimumOrderValue

public Service setMinimumOrderValue(Price minimumOrderValue)

Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.

Parameters:

minimumOrderValue - minimumOrderValue or null for none

getMinimumOrderValueTable

public MinimumOrderValueTable getMinimumOrderValueTable()

Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.

Returns:

value or null for none

setMinimumOrderValueTable

public Service setMinimumOrderValueTable(MinimumOrderValueTable minimumOrderValueTable)

Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.

Parameters:

minimumOrderValueTable - minimumOrderValueTable or null for none

getName

public String getName()

Free-form name of the service. Must be unique within target account. Required.

Returns:

value or null for none

setName

public Service setName(String name)

Free-form name of the service. Must be unique within target account. Required.

Parameters:

name - name or null for none

getPickupService

public PickupCarrierService getPickupService()

The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved through the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.

Returns:

value or null for none

setPickupService

public Service setPickupService(PickupCarrierService pickupService)

The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved through the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`.

Parameters:

pickupService - pickupService or null for none

getRateGroups

public List<RateGroup> getRateGroups()

Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.

Returns:

value or null for none

setRateGroups

public Service setRateGroups(List<RateGroup> rateGroups)

Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap.

Parameters:

rateGroups - rateGroups or null for none

getShipmentType

public String getShipmentType()

Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup` (deprecated)" - "`local_delivery`" - "`collection_point`"

Returns:

value or null for none

setShipmentType

public Service setShipmentType(String shipmentType)

Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup` (deprecated)" - "`local_delivery`" - "`collection_point`"

Parameters:

shipmentType - shipmentType or null for none

getStoreConfig

public ServiceStoreConfig getStoreConfig()

A list of stores your products are delivered from. This is only available for the local delivery shipment type.

Returns:

value or null for none

setStoreConfig

public Service setStoreConfig(ServiceStoreConfig storeConfig)

A list of stores your products are delivered from. This is only available for the local delivery shipment type.

Parameters:

storeConfig - storeConfig or null for none

set

public Service set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Service clone()

Overrides:

clone in class com.google.api.client.json.GenericJson