target.apidocs.com.google.api.services.content.model.OrderCancellation.html Maven / Gradle / Ivy
OrderCancellation (Content API for Shopping v2.1-rev20240609-2.0.0)
com.google.api.services.content.model
Class OrderCancellation
- 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.OrderCancellation
-
public final class OrderCancellation
extends com.google.api.client.json.GenericJson
Model definition for OrderCancellation.
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>
-
Constructor Summary
Constructors
Constructor and Description
OrderCancellation()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
OrderCancellation
clone()
String
getActor()
The actor that created the cancellation.
String
getCreationDate()
Date on which the cancellation has been created, in ISO 8601 format.
Long
getQuantity()
The quantity that was canceled.
String
getReason()
The reason for the cancellation.
String
getReasonText()
The explanation of the reason.
OrderCancellation
set(String fieldName,
Object value)
OrderCancellation
setActor(String actor)
The actor that created the cancellation.
OrderCancellation
setCreationDate(String creationDate)
Date on which the cancellation has been created, in ISO 8601 format.
OrderCancellation
setQuantity(Long quantity)
The quantity that was canceled.
OrderCancellation
setReason(String reason)
The reason for the cancellation.
OrderCancellation
setReasonText(String reasonText)
The explanation of the reason.
-
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
-
-
Method Detail
-
getActor
public String getActor()
The actor that created the cancellation. Acceptable values are: - "`customer`" - "`googleBot`"
- "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`"
- Returns:
- value or
null
for none
-
setActor
public OrderCancellation setActor(String actor)
The actor that created the cancellation. Acceptable values are: - "`customer`" - "`googleBot`"
- "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`"
- Parameters:
actor
- actor or null
for none
-
getCreationDate
public String getCreationDate()
Date on which the cancellation has been created, in ISO 8601 format.
- Returns:
- value or
null
for none
-
setCreationDate
public OrderCancellation setCreationDate(String creationDate)
Date on which the cancellation has been created, in ISO 8601 format.
- Parameters:
creationDate
- creationDate or null
for none
-
getQuantity
public Long getQuantity()
The quantity that was canceled.
- Returns:
- value or
null
for none
-
setQuantity
public OrderCancellation setQuantity(Long quantity)
The quantity that was canceled.
- Parameters:
quantity
- quantity or null
for none
-
getReason
public String getReason()
The reason for the cancellation. Orders that are canceled with a noInventory reason will lead
to the removal of the product from Buy on Google until you make an update to that product. This
won't affect your Shopping ads. Acceptable values are: - "`autoPostInternal`" -
"`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" -
"`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`customerCanceled`" -
"`customerInitiatedCancel`" - "`customerSupportRequested`" - "`failToPushOrderGoogleError`" -
"`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" -
"`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`invalidCoupon`" -
"`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" -
"`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceError`" -
"`returnRefundAbuse`" - "`shippingPriceError`" - "`taxError`" -
"`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`failedToCaptureFunds`"
- Returns:
- value or
null
for none
-
setReason
public OrderCancellation setReason(String reason)
The reason for the cancellation. Orders that are canceled with a noInventory reason will lead
to the removal of the product from Buy on Google until you make an update to that product. This
won't affect your Shopping ads. Acceptable values are: - "`autoPostInternal`" -
"`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" -
"`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`customerCanceled`" -
"`customerInitiatedCancel`" - "`customerSupportRequested`" - "`failToPushOrderGoogleError`" -
"`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" -
"`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`invalidCoupon`" -
"`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" -
"`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceError`" -
"`returnRefundAbuse`" - "`shippingPriceError`" - "`taxError`" -
"`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`failedToCaptureFunds`"
- Parameters:
reason
- reason or null
for none
-
getReasonText
public String getReasonText()
The explanation of the reason.
- Returns:
- value or
null
for none
-
setReasonText
public OrderCancellation setReasonText(String reasonText)
The explanation of the reason.
- Parameters:
reasonText
- reasonText or null
for none
-
set
public OrderCancellation set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public OrderCancellation clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy