Class: Google::Apis::ContentV2_1::OrderCancellation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/content_v2_1/classes.rb,
generated/google/apis/content_v2_1/representations.rb,
generated/google/apis/content_v2_1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrderCancellation

Returns a new instance of OrderCancellation.



4322
4323
4324
# File 'generated/google/apis/content_v2_1/classes.rb', line 4322

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#actorString

The actor that created the cancellation. Acceptable values are:

  • "customer"
  • "googleBot"
  • "googleCustomerService"
  • "googlePayments"
  • "googleSabre"
  • "merchant" Corresponds to the JSON property actor

Returns:

  • (String)


4269
4270
4271
# File 'generated/google/apis/content_v2_1/classes.rb', line 4269

def actor
  @actor
end

#creation_dateString

Date on which the cancellation has been created, in ISO 8601 format. Corresponds to the JSON property creationDate

Returns:

  • (String)


4274
4275
4276
# File 'generated/google/apis/content_v2_1/classes.rb', line 4274

def creation_date
  @creation_date
end

#quantityFixnum

The quantity that was canceled. Corresponds to the JSON property quantity

Returns:

  • (Fixnum)


4279
4280
4281
# File 'generated/google/apis/content_v2_1/classes.rb', line 4279

def quantity
  @quantity
end

#reasonString

The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not 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" Corresponds to the JSON property reason

Returns:

  • (String)


4315
4316
4317
# File 'generated/google/apis/content_v2_1/classes.rb', line 4315

def reason
  @reason
end

#reason_textString

The explanation of the reason. Corresponds to the JSON property reasonText

Returns:

  • (String)


4320
4321
4322
# File 'generated/google/apis/content_v2_1/classes.rb', line 4320

def reason_text
  @reason_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4327
4328
4329
4330
4331
4332
4333
# File 'generated/google/apis/content_v2_1/classes.rb', line 4327

def update!(**args)
  @actor = args[:actor] if args.key?(:actor)
  @creation_date = args[:creation_date] if args.key?(:creation_date)
  @quantity = args[:quantity] if args.key?(:quantity)
  @reason = args[:reason] if args.key?(:reason)
  @reason_text = args[:reason_text] if args.key?(:reason_text)
end