generated/google/apis/content_v2/classes.rb in google-api-client-0.46.2 vs generated/google/apis/content_v2/classes.rb in google-api-client-0.47.0

- old
+ new

@@ -35,12 +35,12 @@ alias_method :adult_content?, :adult_content # List of linked AdWords accounts that are active or pending approval. To create # a new link request, add a new link with status `active` to the list. It will # remain in a `pending` state until approved or rejected either in the AdWords - # interface or through the AdWords API. To delete an active link, or to cancel - # a link request, remove it from the list. + # interface or through the AdWords API. To delete an active link, or to cancel a + # link request, remove it from the list. # Corresponds to the JSON property `adwordsLinks` # @return [Array<Google::Apis::ContentV2::AccountAdwordsLink>] attr_accessor :adwords_links # The business information of the account. @@ -177,19 +177,17 @@ attr_accessor :adwords_id # Status of the link between this Merchant Center account and the AdWords # account. Upon retrieval, it represents the actual status of the link and can # be either `active` if it was approved in Google AdWords or `pending` if it's - # pending approval. Upon insertion, it represents the intended status of the + # pending approval. Upon insertion, it represents the *intended* status of the # link. Re-uploading a link with status `active` when it's still pending or with # status `pending` when it's already active will have no effect: the status will # remain unchanged. Re-uploading a link with deprecated status `inactive` is # equivalent to not submitting the link at all and will delete the link if it - # was active or cancel the link request if it was pending. - # Acceptable values are: - # - "`active`" - # - "`pending`" + # was active or cancel the link request if it was pending. Acceptable values are: + # - "`active`" - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status def initialize(**args) @@ -275,13 +273,11 @@ # Corresponds to the JSON property `gmbEmail` # @return [String] attr_accessor :gmb_email # Status of the link between this Merchant Center account and the GMB account. - # Acceptable values are: - # - "`active`" - # - "`pending`" + # Acceptable values are: - "`active`" - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status def initialize(**args) @@ -402,15 +398,12 @@ # Issue identifier. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Severity of the issue. - # Acceptable values are: - # - "`critical`" - # - "`error`" - # - "`suggestion`" + # Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "` + # suggestion`" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # Short description of the issue. @@ -481,14 +474,11 @@ # # Corresponds to the JSON property `numItems` # @return [Fixnum] attr_accessor :num_items - # Acceptable values are: - # - "`critical`" - # - "`error`" - # - "`suggestion`" + # Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity # @@ -622,14 +612,12 @@ # class AccountStatusProducts include Google::Apis::Core::Hashable - # The channel the data applies to. - # Acceptable values are: - # - "`local`" - # - "`online`" + # The channel the data applies to. Acceptable values are: - "`local`" - "`online` + # " # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # The country the data applies to. @@ -840,11 +828,11 @@ attr_accessor :channel_id # Status of the link between this Merchant Center account and the YouTube # channel. Upon retrieval, it represents the actual status of the link and can # be either `active` if it was approved in YT Creator Studio or `pending` if it' - # s pending approval. Upon insertion, it represents the intended status of the + # s pending approval. Upon insertion, it represents the *intended* status of the # link. Re-uploading a link with status `active` when it's still pending or with # status `pending` when it's already active will have no effect: the status will # remain unchanged. Re-uploading a link with deprecated status `inactive` is # equivalent to not submitting the link at all and will delete the link if it # was active or cancel the link request if it was pending. @@ -865,15 +853,14 @@ # class AccountsAuthInfoResponse include Google::Apis::Core::Hashable - # The account identifiers corresponding to the authenticated user. - # - For an individual account: only the merchant ID is defined - # - For an aggregator: only the aggregator ID is defined - # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are - # defined. + # The account identifiers corresponding to the authenticated user. - For an + # individual account: only the merchant ID is defined - For an aggregator: only + # the aggregator ID is defined - For a subaccount of an MCA: both the merchant + # ID and the aggregator ID are defined. # Corresponds to the JSON property `accountIdentifiers` # @return [Array<Google::Apis::ContentV2::AccountIdentifier>] attr_accessor :account_identifiers # Identifies what kind of resource this is. Value: the fixed string "content# @@ -973,18 +960,12 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`claimWebsite`" - # - "`delete`" - # - "`get`" - # - "`insert`" - # - "`link`" - # - "`update`" + # The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "` + # delete`" - "`get`" - "`insert`" - "`link`" - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # Only applicable if the method is `claimwebsite`. Indicates whether or not to @@ -1015,23 +996,18 @@ # class AccountsCustomBatchRequestEntryLinkRequest include Google::Apis::Core::Hashable # Action to perform for this link. The `"request"` action is only available to - # select merchants. - # Acceptable values are: - # - "`approve`" - # - "`remove`" - # - "`request`" + # select merchants. Acceptable values are: - "`approve`" - "`remove`" - "` + # request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Type of the link between the two accounts. - # Acceptable values are: - # - "`channelPartner`" - # - "`eCommercePlatform`" + # Type of the link between the two accounts. Acceptable values are: - "` + # channelPartner`" - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type # The ID of the linked account. @@ -1102,15 +1078,12 @@ # accountsCustomBatchResponseEntry`" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Deprecated. This field is never set. - # Acceptable values are: - # - "`active`" - # - "`inactive`" - # - "`pending`" + # Deprecated. This field is never set. Acceptable values are: - "`active`" - "` + # inactive`" - "`pending`" # Corresponds to the JSON property `linkStatus` # @return [String] attr_accessor :link_status def initialize(**args) @@ -1130,23 +1103,18 @@ # class AccountsLinkRequest include Google::Apis::Core::Hashable # Action to perform for this link. The `"request"` action is only available to - # select merchants. - # Acceptable values are: - # - "`approve`" - # - "`remove`" - # - "`request`" + # select merchants. Acceptable values are: - "`approve`" - "`remove`" - "` + # request`" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Type of the link between the two accounts. - # Acceptable values are: - # - "`channelPartner`" - # - "`eCommercePlatform`" + # Type of the link between the two accounts. Acceptable values are: - "` + # channelPartner`" - "`eCommercePlatform`" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type # The ID of the linked account. @@ -1260,13 +1228,11 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" + # The method of the batch entry. Acceptable values are: - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) @@ -1414,14 +1380,11 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" - # - "`update`" + # The method of the batch entry. Acceptable values are: - "`get`" - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) @@ -1674,21 +1637,13 @@ # insertion. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The type of the attribute. - # Acceptable values are: - # - "`boolean`" - # - "`datetimerange`" - # - "`float`" - # - "`group`" - # - "`int`" - # - "`price`" - # - "`text`" - # - "`time`" - # - "`url`" + # The type of the attribute. Acceptable values are: - "`boolean`" - "` + # datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "` + # time`" - "`url`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # Free-form unit of the attribute. Unit can only be used for values of type int, @@ -1747,26 +1702,15 @@ # Description of the reason. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Code of the return reason. - # Acceptable values are: - # - "`betterPriceFound`" - # - "`changedMind`" - # - "`damagedOrDefectiveItem`" - # - "`didNotMatchDescription`" - # - "`doesNotFit`" - # - "`expiredItem`" - # - "`incorrectItemReceived`" - # - "`noLongerNeeded`" - # - "`notSpecified`" - # - "`orderedWrongItem`" - # - "`other`" - # - "`qualityNotExpected`" - # - "`receivedTooLate`" - # - "`undeliverable`" + # Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "` + # changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "` + # doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" + # - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" + # - "`receivedTooLate`" - "`undeliverable`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code def initialize(**args) @@ -1830,15 +1774,12 @@ # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Required. The type of data feed. For product inventory feeds, only feeds for - # local stores, not online stores, are supported. - # Acceptable values are: - # - "`local products`" - # - "`product inventory`" - # - "`products`" + # local stores, not online stores, are supported. Acceptable values are: - "` + # local products`" - "`product inventory`" - "`products`" # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type # The required fields vary based on the frequency of fetching. For a monthly @@ -1862,11 +1803,11 @@ # Required for update. The ID of the data feed. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id - # [DEPRECATED] Please use targets[].includedDestinations instead. The list of + # [DEPRECATED] Please use targets[].includedDestinations instead. The list of # intended destinations (corresponds to checked check boxes in Merchant Center). # Corresponds to the JSON property `intendedDestinations` # @return [Array<String>] attr_accessor :intended_destinations @@ -1963,19 +1904,13 @@ # An optional user name for fetch_url. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username - # The day of the week the feed file should be fetched. - # Acceptable values are: - # - "`monday`" - # - "`tuesday`" - # - "`wednesday`" - # - "`thursday`" - # - "`friday`" - # - "`saturday`" - # - "`sunday`" + # The day of the week the feed file should be fetched. Acceptable values are: - " + # `monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "` + # saturday`" - "`sunday`" # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday def initialize(**args) @@ -2000,36 +1935,25 @@ class DatafeedFormat include Google::Apis::Core::Hashable # Delimiter for the separation of values in a delimiter-separated values feed. # If not specified, the delimiter will be auto-detected. Ignored for non-DSV - # data feeds. - # Acceptable values are: - # - "`pipe`" - # - "`tab`" - # - "`tilde`" + # data feeds. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`" # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter # Character encoding scheme of the data feed. If not specified, the encoding - # will be auto-detected. - # Acceptable values are: - # - "`latin-1`" - # - "`utf-16be`" - # - "`utf-16le`" - # - "`utf-8`" - # - "`windows-1252`" + # will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "` + # utf-16le`" - "`utf-8`" - "`windows-1252`" # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding # Specifies how double quotes are interpreted. If not specified, the mode will - # be auto-detected. Ignored for non-DSV data feeds. - # Acceptable values are: - # - "`normal character`" - # - "`value quoting`" + # be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "` + # normal character`" - "`value quoting`" # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode def initialize(**args) @@ -2047,11 +1971,11 @@ # The status of a datafeed, i.e., the result of the last retrieval of the # datafeed computed asynchronously when the feed processing is finished. class DatafeedStatus include Google::Apis::Core::Hashable - # The country for which the status is reported, represented as a CLDR territory + # The country for which the status is reported, represented as a CLDR territory # code. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -2089,16 +2013,14 @@ # The last date at which the feed was uploaded. # Corresponds to the JSON property `lastUploadDate` # @return [String] attr_accessor :last_upload_date - # The processing status of the feed. - # Acceptable values are: - # - "`"`failure`": The feed could not be processed or all items had errors.`" - # - "`in progress`": The feed is being processed. - # - "`none`": The feed has not yet been processed. For example, a feed that has - # never been uploaded will have this processing status. + # The processing status of the feed. Acceptable values are: - "`"`failure`": The + # feed could not be processed or all items had errors.`" - "`in progress`": The + # feed is being processed. - "`none`": The feed has not yet been processed. For + # example, a feed that has never been uploaded will have this processing status. # - "`success`": The feed was processed successfully, though some items might # have had errors. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status @@ -2198,11 +2120,11 @@ # class DatafeedTarget include Google::Apis::Core::Hashable # The country where the items in the feed will be included in the search index, - # represented as a CLDR territory code. + # represented as a CLDR territory code. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The list of destinations to exclude for this target (corresponds to unchecked @@ -2211,16 +2133,13 @@ # @return [Array<String>] attr_accessor :excluded_destinations # The list of destinations to include for this target (corresponds to checked # check boxes in Merchant Center). Default destinations are always included - # unless provided in `excludedDestinations`. - # List of supported destinations (if available to the account): - # - DisplayAds - # - Shopping - # - ShoppingActions - # - SurfacesAcrossGoogle + # unless provided in `excludedDestinations`. List of supported destinations (if + # available to the account): - DisplayAds - Shopping - ShoppingActions - + # SurfacesAcrossGoogle # Corresponds to the JSON property `includedDestinations` # @return [Array<String>] attr_accessor :included_destinations # The two-letter ISO 639-1 language of the items in the feed. Must be a valid @@ -2283,17 +2202,12 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`delete`" - # - "`fetchNow`" - # - "`get`" - # - "`insert`" - # - "`update`" + # The method of the batch entry. Acceptable values are: - "`delete`" - "` + # fetchNow`" - "`get`" - "`insert`" - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) @@ -2469,13 +2383,11 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" + # The method of the batch entry. Acceptable values are: - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method def initialize(**args) @@ -2798,12 +2710,12 @@ # @return [Array<Google::Apis::ContentV2::LocationIdSet>] attr_accessor :locations # A list of inclusive number of items upper bounds. The last value can be `" # infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= - # 10 items", " 50 items". Must be non-empty. Can only be set if all other fields - # are not set. + # 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set + # if all other fields are not set. # Corresponds to the JSON property `numberOfItems` # @return [Array<String>] attr_accessor :number_of_items # A list of postal group names. The last value can be `"all other locations"`. @@ -2815,21 +2727,22 @@ attr_accessor :postal_code_group_names # A list of inclusive order price upper bounds. The last price's value can be `" # infinity"`. For example `[`"value": "10", "currency": "USD"`, `"value": "500", # "currency": "USD"`, `"value": "infinity", "currency": "USD"`]` represents the - # headers "<= $10", " $500". All prices within a service must have the same - # currency. Must be non-empty. Can only be set if all other fields are not set. + # headers "<= $10", "<= $500", and "> $500". All prices within a service must + # have the same currency. Must be non-empty. Can only be set if all other fields + # are not set. # Corresponds to the JSON property `prices` # @return [Array<Google::Apis::ContentV2::Price>] attr_accessor :prices # A list of inclusive order weight upper bounds. The last weight's value can be ` # "infinity"`. For example `[`"value": "10", "unit": "kg"`, `"value": "50", " # unit": "kg"`, `"value": "infinity", "unit": "kg"`]` represents the headers "<= - # 10kg", " 50kg". All weights within a service must have the same unit. Must be - # non-empty. Can only be set if all other fields are not set. + # 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the + # same unit. Must be non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `weights` # @return [Array<Google::Apis::ContentV2::Weight>] attr_accessor :weights def initialize(**args) @@ -2862,11 +2775,11 @@ # Corresponds to the JSON property `deadlineHour` # @return [Fixnum] attr_accessor :deadline_hour # Timezone identifier for the deadline hour. A list of identifiers can be found - # in the AdWords API documentation. E.g. "Europe/Zurich". Required. + # in the AdWords API documentation. E.g. "Europe/Zurich". Required. # Corresponds to the JSON property `deadlineTimezone` # @return [String] attr_accessor :deadline_timezone # Unique identifier for the holiday. Required. @@ -2928,20 +2841,13 @@ # Always present. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The holiday type. Always present. - # Acceptable values are: - # - "`Christmas`" - # - "`Easter`" - # - "`Father's Day`" - # - "`Halloween`" - # - "`Independence Day (USA)`" - # - "`Mother's Day`" - # - "`Thanksgiving`" - # - "`Valentine's Day`" + # The holiday type. Always present. Acceptable values are: - "`Christmas`" - "` + # Easter`" - "`Father's Day`" - "`Halloween`" - "`Independence Day (USA)`" - "` + # Mother's Day`" - "`Thanksgiving`" - "`Valentine's Day`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -2982,19 +2888,16 @@ @amount = args[:amount] if args.key?(:amount) @months = args[:months] if args.key?(:months) end end - # (== resource_for v2.inventory ==) + # class Inventory include Google::Apis::Core::Hashable - # The availability of the product. - # Acceptable values are: - # - "`in stock`" - # - "`out of stock`" - # - "`preorder`" + # The availability of the product. Acceptable values are: - "`in stock`" - "`out + # of stock`" - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # Custom label 0 for custom grouping of items in a Shopping campaign. Only @@ -3136,11 +3039,11 @@ # An entry ID, unique within the batch request. # Corresponds to the JSON property `batchId` # @return [Fixnum] attr_accessor :batch_id - # (== resource_for v2.inventory ==) + # Price and availability of the product. # Corresponds to the JSON property `inventory` # @return [Google::Apis::ContentV2::Inventory] attr_accessor :inventory # The ID of the managing account. @@ -3236,34 +3139,21 @@ include Google::Apis::Core::Hashable # Whether store pickup is available for this offer and whether the pickup option # should be shown as buy, reserve, or not supported. Only supported for local # inventory. Unless the value is "not supported", must be submitted together - # with `pickupSla`. - # Acceptable values are: - # - "`buy`" - # - "`not supported`" - # - "`reserve`" - # - "`ship to store`" + # with `pickupSla`. Acceptable values are: - "`buy`" - "`not supported`" - "` + # reserve`" - "`ship to store`" # Corresponds to the JSON property `pickupMethod` # @return [String] attr_accessor :pickup_method # The expected date that an order will be ready for pickup, relative to when the # order is placed. Only supported for local inventory. Must be submitted - # together with `pickupMethod`. - # Acceptable values are: - # - "`five day`" - # - "`four day`" - # - "`multi day`" - # - "`multi week`" - # - "`next day`" - # - "`same day`" - # - "`seven day`" - # - "`six day`" - # - "`three day`" - # - "`two day`" + # together with `pickupMethod`. Acceptable values are: - "`five day`" - "`four + # day`" - "`multi day`" - "`multi week`" - "`next day`" - "`same day`" - "`seven + # day`" - "`six day`" - "`three day`" - "`two day`" # Corresponds to the JSON property `pickupSla` # @return [String] attr_accessor :pickup_sla def initialize(**args) @@ -3279,15 +3169,12 @@ # class SetInventoryRequest include Google::Apis::Core::Hashable - # The availability of the product. - # Acceptable values are: - # - "`in stock`" - # - "`out of stock`" - # - "`preorder`" + # The availability of the product. Acceptable values are: - "`in stock`" - "`out + # of stock`" - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # Custom label 0 for custom grouping of items in a Shopping campaign. Only @@ -3472,13 +3359,12 @@ # [required] Total additional charge for this type. # Corresponds to the JSON property `totalAmount` # @return [Google::Apis::ContentV2::Amount] attr_accessor :total_amount - # [required] Type of the additional charge. - # Acceptable values are: - # - "`shipping`" + # [required] Type of the additional charge. Acceptable values are: - "`shipping`" + # # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -3494,15 +3380,12 @@ # class LiaAboutPageSettings include Google::Apis::Core::Hashable - # The status of the verification process for the About page. - # Acceptable values are: - # - "`active`" - # - "`inactive`" - # - "`pending`" + # The status of the verification process for the About page. Acceptable values + # are: - "`active`" - "`inactive`" - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The URL for the About page. @@ -3590,24 +3473,18 @@ # The name of the contact for the inventory verification process. # Corresponds to the JSON property `inventoryVerificationContactName` # @return [String] attr_accessor :inventory_verification_contact_name - # The status of the verification contact. - # Acceptable values are: - # - "`active`" - # - "`inactive`" - # - "`pending`" + # The status of the verification contact. Acceptable values are: - "`active`" - " + # `inactive`" - "`pending`" # Corresponds to the JSON property `inventoryVerificationContactStatus` # @return [String] attr_accessor :inventory_verification_contact_status - # The status of the inventory verification process. - # Acceptable values are: - # - "`active`" - # - "`inactive`" - # - "`pending`" + # The status of the inventory verification process. Acceptable values are: - "` + # active`" - "`inactive`" - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status def initialize(**args) @@ -3630,15 +3507,12 @@ # Shipping cost and policy URL. # Corresponds to the JSON property `shippingCostPolicyUrl` # @return [String] attr_accessor :shipping_cost_policy_url - # The status of the ?On display to order? feature. - # Acceptable values are: - # - "`active`" - # - "`inactive`" - # - "`pending`" + # The status of the ?On display to order? feature. Acceptable values are: - "` + # active`" - "`inactive`" - "`pending`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status def initialize(**args) @@ -3775,18 +3649,14 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" - # - "`getAccessibleGmbAccounts`" - # - "`requestGmbAccess`" - # - "`requestInventoryVerification`" - # - "`setInventoryVerificationContact`" - # - "`update`" + # The method of the batch entry. Acceptable values are: - "`get`" - "` + # getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "` + # requestInventoryVerification`" - "`setInventoryVerificationContact`" - "` + # update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The ID of POS data provider. Required only for SetPosProvider. @@ -4197,17 +4067,12 @@ # IDs of the return shipments that this return item belongs to. # Corresponds to the JSON property `returnShipmentIds` # @return [Array<String>] attr_accessor :return_shipment_ids - # State of the item. - # Acceptable values are: - # - "`canceled`" - # - "`new`" - # - "`received`" - # - "`refunded`" - # - "`rejected`" + # State of the item. Acceptable values are: - "`canceled`" - "`new`" - "` + # received`" - "`refunded`" - "`rejected`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) @@ -4271,25 +4136,21 @@ @value = args[:value] if args.key?(:value) end end # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. - # orders ==) + # Sandbox access does not. class Order include Google::Apis::Core::Hashable # Whether the order was acknowledged. # Corresponds to the JSON property `acknowledged` # @return [Boolean] attr_accessor :acknowledged alias_method :acknowledged?, :acknowledged - # Deprecated. - # Acceptable values are: - # - "`googleExpress`" - # - "`purchasesOnGoogle`" + # Deprecated. Acceptable values are: - "`googleExpress`" - "`purchasesOnGoogle`" # Corresponds to the JSON property `channelType` # @return [String] attr_accessor :channel_type # The details of the customer who placed the order. @@ -4338,16 +4199,12 @@ # The details of the payment method. # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2::OrderPaymentMethod] attr_accessor :payment_method - # The status of the payment. - # Acceptable values are: - # - "`paymentCaptured`" - # - "`paymentRejected`" - # - "`paymentSecured`" - # - "`pendingAuthorization`" + # The status of the payment. Acceptable values are: - "`paymentCaptured`" - "` + # paymentRejected`" - "`paymentSecured`" - "`pendingAuthorization`" # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status # Pickup details for shipments of type `pickup`. @@ -4358,28 +4215,26 @@ # The date when the order was placed, in ISO 8601 format. # Corresponds to the JSON property `placedDate` # @return [String] attr_accessor :placed_date - # The details of the merchant provided promotions applied to the order. - # To determine which promotions apply to which products, check the `Promotions[]. + # The details of the merchant provided promotions applied to the order. To + # determine which promotions apply to which products, check the `Promotions[]. # Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` field for # each promotion. If a promotion is applied to more than 1 `offerId`, divide the # discount value by the number of affected offers to determine how much discount - # to apply to each `offerId`. - # Examples: - # - To calculate the line item level discount for a single specific item: For - # each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount - # from the `LineItems[].Price.value`. - # - To calculate the line item level discount for multiple quantity of a - # specific item: For each promotion, divide the `Promotions[].Benefits[]. + # to apply to each `offerId`. Examples: 1. To calculate the line item level + # discount for a single specific item: For each promotion, subtract the ` + # Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price. + # value`. 2. To calculate the line item level discount for multiple quantity of + # a specific item: For each promotion, divide the `Promotions[].Benefits[]. # Discount.value` by the quantity of products and substract it from `LineItems[]. - # Product.Price.value` for each quantity item. - # Only 1 promotion can be applied to an offerId in a given order. To refund an - # item which had a promotion applied to it, make sure to refund the amount after - # first subtracting the promotion discount from the item price. - # More details about the program are here. + # Product.Price.value` for each quantity item. Only 1 promotion can be applied + # to an offerId in a given order. To refund an item which had a promotion + # applied to it, make sure to refund the amount after first subtracting the + # promotion discount from the item price. More details about the program are + # here. # Corresponds to the JSON property `promotions` # @return [Array<Google::Apis::ContentV2::OrderLegacyPromotion>] attr_accessor :promotions # Refunds for the order. @@ -4400,41 +4255,26 @@ # The tax for the total shipping cost. # Corresponds to the JSON property `shippingCostTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost_tax - # Deprecated. Shipping details are provided with line items instead. - # Acceptable values are: - # - "`economy`" - # - "`expedited`" - # - "`oneDay`" - # - "`sameDay`" - # - "`standard`" - # - "`twoDay`" + # Deprecated. Shipping details are provided with line items instead. Acceptable + # values are: - "`economy`" - "`expedited`" - "`oneDay`" - "`sameDay`" - "` + # standard`" - "`twoDay`" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option - # The status of the order. - # Acceptable values are: - # - "`canceled`" - # - "`delivered`" - # - "`inProgress`" - # - "`partiallyDelivered`" - # - "`partiallyReturned`" - # - "`partiallyShipped`" - # - "`pendingShipment`" - # - "`returned`" - # - "`shipped`" + # The status of the order. Acceptable values are: - "`canceled`" - "`delivered`" + # - "`inProgress`" - "`partiallyDelivered`" - "`partiallyReturned`" - "` + # partiallyShipped`" - "`pendingShipment`" - "`returned`" - "`shipped`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # The party responsible for collecting and remitting taxes. - # Acceptable values are: - # - "`marketplaceFacilitator`" - # - "`merchant`" + # The party responsible for collecting and remitting taxes. Acceptable values + # are: - "`marketplaceFacilitator`" - "`merchant`" # Corresponds to the JSON property `taxCollector` # @return [String] attr_accessor :tax_collector def initialize(**args) @@ -4476,15 +4316,12 @@ # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # Strings representing the lines of the printed label for mailing the order, for - # example: - # John Smith - # 1600 Amphitheatre Parkway - # Mountain View, CA, 94043 - # United States + # example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United + # States # Corresponds to the JSON property `fullAddress` # @return [Array<String>] attr_accessor :full_address # Whether the address is a post office box. @@ -4539,18 +4376,13 @@ # class OrderCancellation include Google::Apis::Core::Hashable - # The actor that created the cancellation. - # Acceptable values are: - # - "`customer`" - # - "`googleBot`" - # - "`googleCustomerService`" - # - "`googlePayments`" - # - "`googleSabre`" - # - "`merchant`" + # The actor that created the cancellation. Acceptable values are: - "`customer`" + # - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "` + # googleSabre`" - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor # Date on which the cancellation has been created, in ISO 8601 format. @@ -4564,39 +4396,22 @@ attr_accessor :quantity # 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`" + # 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` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -4638,11 +4453,11 @@ # @return [String] attr_accessor :full_name # Email address for the merchant to send value-added tax or invoice # documentation of the order. Only the last document sent is made available to - # the customer. For more information, see About automated VAT invoicing for + # the customer. For more information, see About automated VAT invoicing for # Shopping Actions. # Corresponds to the JSON property `invoiceReceivingEmail` # @return [String] attr_accessor :invoice_receiving_email @@ -4674,14 +4489,12 @@ # Last known customer selection regarding marketing preferences. In certain # cases this selection might not be known, so this field would be empty. If a # customer selected `granted` in their most recent order, they can be subscribed # to marketing emails. Customers who have chosen `denied` must not be subscribed, - # or must be unsubscribed if already opted-in. - # Acceptable values are: - # - "`denied`" - # - "`granted`" + # or must be unsubscribed if already opted-in. Acceptable values are: - "` + # denied`" - "`granted`" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference # Timestamp when last time marketing preference was updated. Could be empty, if @@ -4743,15 +4556,15 @@ # @return [Array<Google::Apis::ContentV2::OrderLegacyPromotionBenefit>] attr_accessor :benefits # The date and time frame when the promotion is active and ready for validation # review. Note that the promotion live time may be delayed for a few hours due - # to the validation review. - # Start date and end date are separated by a forward slash (/). The start date - # is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time - # of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an - # expression of the time zone for the sale. The end date is in the same format. + # to the validation review. Start date and end date are separated by a forward + # slash (/). The start date is specified by the format (YYYY-MM-DD), followed by + # the letter ?T?, the time of the day when the sale starts (in Greenwich Mean + # Time, GMT), followed by an expression of the time zone for the sale. The end + # date is in the same format. # Corresponds to the JSON property `effectiveDates` # @return [String] attr_accessor :effective_dates # Optional. The text code that corresponds to the promotion when applied on the @@ -4769,20 +4582,17 @@ # Corresponds to the JSON property `longTitle` # @return [String] attr_accessor :long_title # Whether the promotion is applicable to all products or only specific products. - # Acceptable values are: - # - "`allProducts`" - # - "`specificProducts`" + # Acceptable values are: - "`allProducts`" - "`specificProducts`" # Corresponds to the JSON property `productApplicability` # @return [String] attr_accessor :product_applicability - # Indicates that the promotion is valid online. - # Acceptable values are: - # - "`online`" + # Indicates that the promotion is valid online. Acceptable values are: - "` + # online`" # Corresponds to the JSON property `redemptionChannel` # @return [String] attr_accessor :redemption_channel def initialize(**args) @@ -4815,40 +4625,28 @@ # Corresponds to the JSON property `offerIds` # @return [Array<String>] attr_accessor :offer_ids # Further describes the benefit of the promotion. Note that we will expand on - # this enumeration as we support new promotion sub-types. - # Acceptable values are: - # - "`buyMGetMoneyOff`" - # - "`buyMGetNMoneyOff`" - # - "`buyMGetNPercentOff`" - # - "`buyMGetPercentOff`" - # - "`freeGift`" - # - "`freeGiftWithItemId`" - # - "`freeGiftWithValue`" - # - "`freeOvernightShipping`" - # - "`freeShipping`" - # - "`freeTwoDayShipping`" - # - "`moneyOff`" - # - "`percentageOff`" - # - "`rewardPoints`" - # - "`salePrice`" + # this enumeration as we support new promotion sub-types. Acceptable values are: + # - "`buyMGetMoneyOff`" - "`buyMGetNMoneyOff`" - "`buyMGetNPercentOff`" - "` + # buyMGetPercentOff`" - "`freeGift`" - "`freeGiftWithItemId`" - "` + # freeGiftWithValue`" - "`freeOvernightShipping`" - "`freeShipping`" - "` + # freeTwoDayShipping`" - "`moneyOff`" - "`percentageOff`" - "`rewardPoints`" - "` + # salePrice`" # Corresponds to the JSON property `subType` # @return [String] attr_accessor :sub_type # The impact on tax when the promotion is applied. # Corresponds to the JSON property `taxImpact` # @return [Google::Apis::ContentV2::Price] attr_accessor :tax_impact # Describes whether the promotion applies to products (e.g. 20% off) or to - # shipping (e.g. Free Shipping). - # Acceptable values are: - # - "`product`" - # - "`shipping`" + # shipping (e.g. Free Shipping). Acceptable values are: - "`product`" - "` + # shipping`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -4985,23 +4783,18 @@ # Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand - # The item's channel (online or local). - # Acceptable values are: - # - "`local`" - # - "`online`" + # The item's channel (online or local). Acceptable values are: - "`local`" - "` + # online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel - # Condition or state of the item. - # Acceptable values are: - # - "`new`" - # - "`refurbished`" - # - "`used`" + # Condition or state of the item. Acceptable values are: - "`new`" - "` + # refurbished`" - "`used`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # The two-letter ISO 639-1 language code for the item. @@ -5052,11 +4845,11 @@ # URL to the cached image shown to the user when order was placed. # Corresponds to the JSON property `shownImage` # @return [String] attr_accessor :shown_image - # The CLDR territory code of the target country of the product. + # The CLDR territory // code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # The title of the product. @@ -5196,14 +4989,12 @@ # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date # Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is - # applicable for this shipment. - # Acceptable values are: - # - "`delivery`" - # - "`pickup`" + # applicable for this shipment. Acceptable values are: - "`delivery`" - "`pickup` + # " # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -5311,19 +5102,12 @@ # The billing phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number - # The type of instrument. - # Acceptable values are: - # - "`AMEX`" - # - "`DISCOVER`" - # - "`JCB`" - # - "`MASTERCARD`" - # - "`UNIONPAY`" - # - "`VISA`" - # - "``" + # The type of instrument. Acceptable values are: - "`AMEX`" - "`DISCOVER`" - "` + # JCB`" - "`MASTERCARD`" - "`UNIONPAY`" - "`VISA`" - "``" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -5401,17 +5185,12 @@ # class OrderRefund include Google::Apis::Core::Hashable - # The actor that created the refund. - # Acceptable values are: - # - "`customer`" - # - "`googleBot`" - # - "`googleCustomerService`" - # - "`googlePayments`" - # - "`googleSabre`" + # The actor that created the refund. Acceptable values are: - "`customer`" - "` + # googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5423,56 +5202,27 @@ # Date on which the item has been created, in ISO 8601 format. # Corresponds to the JSON property `creationDate` # @return [String] attr_accessor :creation_date - # The reason for the refund. - # Acceptable values are: - # - "`adjustment`" - # - "`autoPostInternal`" - # - "`autoPostInvalidBillingAddress`" - # - "`autoPostNoInventory`" - # - "`autoPostPriceError`" - # - "`autoPostUndeliverableShippingAddress`" - # - "`couponAbuse`" - # - "`courtesyAdjustment`" - # - "`customerCanceled`" - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`customerSupportRequested`" - # - "`deliveredLateByCarrier`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`failToPushOrderGoogleError`" - # - "`failToPushOrderMerchantError`" - # - "`failToPushOrderMerchantFulfillmentError`" - # - "`failToPushOrderToMerchant`" - # - "`failToPushOrderToMerchantOutOfStock`" - # - "`feeAdjustment`" - # - "`invalidCoupon`" - # - "`lateShipmentCredit`" - # - "`malformedShippingAddress`" - # - "`merchantDidNotShipOnTime`" - # - "`noInventory`" - # - "`orderTimeout`" - # - "`other`" - # - "`paymentAbuse`" - # - "`paymentDeclined`" - # - "`priceAdjustment`" - # - "`priceError`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`promoReallocation`" - # - "`qualityNotAsExpected`" - # - "`returnRefundAbuse`" - # - "`shippingCostAdjustment`" - # - "`shippingPriceError`" - # - "`taxAdjustment`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the refund. Acceptable values are: - "`adjustment`" - "` + # autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory` + # " - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "` + # couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" + # - "`expiredItem`" - "`failToPushOrderGoogleError`" - "` + # failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - + # "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "` + # feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "` + # malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - " + # `orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "` + # priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "` + # returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "` + # taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "` + # unsupportedPoBoxAddress`" - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -5492,12 +5242,11 @@ @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end end - # Order disbursement. All methods require the payment analyst role. (== - # resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==) + # Order disbursement. All methods require the payment analyst role. class OrderReportDisbursement include Google::Apis::Core::Hashable # The disbursement amount. # Corresponds to the JSON property `disbursementAmount` @@ -5613,17 +5362,12 @@ # class OrderReturn include Google::Apis::Core::Hashable - # The actor that created the refund. - # Acceptable values are: - # - "`customer`" - # - "`googleBot`" - # - "`googleCustomerService`" - # - "`googlePayments`" - # - "`googleSabre`" + # The actor that created the refund. Acceptable values are: - "`customer`" - "` + # googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" # - "`merchant`" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5635,25 +5379,17 @@ # Quantity that is returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -5677,63 +5413,37 @@ # class OrderShipment include Google::Apis::Core::Hashable - # The carrier handling the shipment. - # For supported carriers, Google includes the carrier name and tracking URL in - # emails to customers. For select supported carriers, Google also automatically - # updates the shipment status based on the provided shipment ID. Note: You can - # also use unsupported carriers, but emails to customers will not include the - # carrier name or tracking URL, and there will be no automatic order status - # updates. - # Supported carriers for US are: - # - "`ups`" (United Parcel Service) automatic status updates - # - "`usps`" (United States Postal Service) automatic status updates - # - "`fedex`" (FedEx) automatic status updates - # - "`dhl`" (DHL eCommerce) automatic status updates (US only) - # - "`ontrac`" (OnTrac) automatic status updates - # - "`dhl express`" (DHL Express) - # - "`deliv`" (Deliv) - # - "`dynamex`" (TForce) - # - "`lasership`" (LaserShip) - # - "`mpx`" (Military Parcel Xpress) - # - "`uds`" (United Delivery Service) - # - "`efw`" (Estes Forwarding Worldwide) - # - "`jd logistics`" (JD Logistics) - # - "`yunexpress`" (YunExpress) - # - "`china post`" (China Post) - # - "`china ems`" (China Post Express Mail Service) - # - "`singapore post`" (Singapore Post) - # - "`pos malaysia`" (Pos Malaysia) - # - "`postnl`" (PostNL) - # - "`ptt`" (PTT Turkish Post) - # - "`eub`" (ePacket) - # - "`chukou1`" (Chukou1 Logistics) - # - "`bestex`" (Best Express) - # - "`canada post`" (Canada Post) - # - "`purolator`" (Purolator) - # - "`canpar`" (Canpar) - # - "`india post`" (India Post) - # - "`blue dart`" (Blue Dart) - # - "`delhivery`" (Delhivery) - # - "`dtdc`" (DTDC) - # - "`tpc india`" (TPC India) - # Supported carriers for FR are: - # - "`la poste`" (La Poste) automatic status updates - # - "`colissimo`" (Colissimo by La Poste) automatic status updates - # - "`ups`" (United Parcel Service) automatic status updates - # - "`chronopost`" (Chronopost by La Poste) - # - "`gls`" (General Logistics Systems France) - # - "`dpd`" (DPD Group by GeoPost) - # - "`bpost`" (Belgian Post Group) - # - "`colis prive`" (Colis Privé) - # - "`boxtal`" (Boxtal) - # - "`geodis`" (GEODIS) - # - "`tnt`" (TNT) - # - "`db schenker`" (DB Schenker) - # - "`aramex`" (Aramex) + # The carrier handling the shipment. For supported carriers, Google includes the + # carrier name and tracking URL in emails to customers. For select supported + # carriers, Google also automatically updates the shipment status based on the + # provided shipment ID. *Note:* You can also use unsupported carriers, but + # emails to customers will not include the carrier name or tracking URL, and + # there will be no automatic order status updates. Supported carriers for US are: + # - "`ups`" (United Parcel Service) *automatic status updates* - "`usps`" ( + # United States Postal Service) *automatic status updates* - "`fedex`" (FedEx) * + # automatic status updates * - "`dhl`" (DHL eCommerce) *automatic status updates* + # (US only) - "`ontrac`" (OnTrac) *automatic status updates * - "`dhl express`" + # (DHL Express) - "`deliv`" (Deliv) - "`dynamex`" (TForce) - "`lasership`" ( + # LaserShip) - "`mpx`" (Military Parcel Xpress) - "`uds`" (United Delivery + # Service) - "`efw`" (Estes Forwarding Worldwide) - "`jd logistics`" (JD + # Logistics) - "`yunexpress`" (YunExpress) - "`china post`" (China Post) - "` + # china ems`" (China Post Express Mail Service) - "`singapore post`" (Singapore + # Post) - "`pos malaysia`" (Pos Malaysia) - "`postnl`" (PostNL) - "`ptt`" (PTT + # Turkish Post) - "`eub`" (ePacket) - "`chukou1`" (Chukou1 Logistics) - "`bestex` + # " (Best Express) - "`canada post`" (Canada Post) - "`purolator`" (Purolator) - + # "`canpar`" (Canpar) - "`india post`" (India Post) - "`blue dart`" (Blue Dart) - + # "`delhivery`" (Delhivery) - "`dtdc`" (DTDC) - "`tpc india`" (TPC India) + # Supported carriers for FR are: - "`la poste`" (La Poste) *automatic status + # updates * - "`colissimo`" (Colissimo by La Poste) *automatic status updates* - + # "`ups`" (United Parcel Service) *automatic status updates * - "`chronopost`" ( + # Chronopost by La Poste) - "`gls`" (General Logistics Systems France) - "`dpd`" + # (DPD Group by GeoPost) - "`bpost`" (Belgian Post Group) - "`colis prive`" ( + # Colis Privé) - "`boxtal`" (Boxtal) - "`geodis`" (GEODIS) - "`tnt`" (TNT) - "` + # db schenker`" (DB Schenker) - "`aramex`" (Aramex) # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been created, in ISO 8601 format. @@ -5760,16 +5470,12 @@ # Delivery details of the shipment if scheduling is needed. # Corresponds to the JSON property `scheduledDeliveryDetails` # @return [Google::Apis::ContentV2::OrderShipmentScheduledDeliveryDetails] attr_accessor :scheduled_delivery_details - # The status of the shipment. - # Acceptable values are: - # - "`delivered`" - # - "`readyForPickup`" - # - "`shipped`" - # - "`undeliverable`" + # The status of the shipment. Acceptable values are: - "`delivered`" - "` + # readyForPickup`" - "`shipped`" - "`undeliverable`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking ID for the shipment. @@ -5902,14 +5608,12 @@ # class OrderinvoicesCreateChargeInvoiceResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -5978,14 +5682,12 @@ # class OrderinvoicesCreateRefundInvoiceResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -6012,56 +5714,27 @@ # Optional description of the refund reason. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [required] Reason for the refund. - # Acceptable values are: - # - "`adjustment`" - # - "`autoPostInternal`" - # - "`autoPostInvalidBillingAddress`" - # - "`autoPostNoInventory`" - # - "`autoPostPriceError`" - # - "`autoPostUndeliverableShippingAddress`" - # - "`couponAbuse`" - # - "`courtesyAdjustment`" - # - "`customerCanceled`" - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`customerSupportRequested`" - # - "`deliveredLateByCarrier`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`failToPushOrderGoogleError`" - # - "`failToPushOrderMerchantError`" - # - "`failToPushOrderMerchantFulfillmentError`" - # - "`failToPushOrderToMerchant`" - # - "`failToPushOrderToMerchantOutOfStock`" - # - "`feeAdjustment`" - # - "`invalidCoupon`" - # - "`lateShipmentCredit`" - # - "`malformedShippingAddress`" - # - "`merchantDidNotShipOnTime`" - # - "`noInventory`" - # - "`orderTimeout`" - # - "`other`" - # - "`paymentAbuse`" - # - "`paymentDeclined`" - # - "`priceAdjustment`" - # - "`priceError`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`promoReallocation`" - # - "`qualityNotAsExpected`" - # - "`returnRefundAbuse`" - # - "`shippingCostAdjustment`" - # - "`shippingPriceError`" - # - "`taxAdjustment`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "` + # autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory` + # " - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "` + # couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" + # - "`expiredItem`" - "`failToPushOrderGoogleError`" - "` + # failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - + # "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "` + # feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "` + # malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - " + # `orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "` + # priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "` + # returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "` + # taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "` + # unsupportedPoBoxAddress`" - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) @@ -6082,25 +5755,17 @@ # Optional description of the return reason. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # [required] Reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # [required] Reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) @@ -6231,14 +5896,12 @@ # class OrdersAcknowledgeResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -6320,22 +5983,14 @@ # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the cancellation. - # Acceptable values are: - # - "`customerInitiatedCancel`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`shippingPriceError`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" + # The reason for the cancellation. Acceptable values are: - "` + # customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - + # "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "` + # taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -6363,14 +6018,12 @@ # class OrdersCancelLineItemResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -6397,22 +6050,14 @@ # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id - # The reason for the cancellation. - # Acceptable values are: - # - "`customerInitiatedCancel`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`shippingPriceError`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" + # The reason for the cancellation. Acceptable values are: - "` + # customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - + # "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "` + # taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -6434,14 +6079,12 @@ # class OrdersCancelResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -6463,15 +6106,12 @@ # class OrdersCancelTestOrderByCustomerRequest include Google::Apis::Core::Hashable - # The reason for the cancellation. - # Acceptable values are: - # - "`changedMind`" - # - "`orderedWrongItem`" - # - "`other`" + # The reason for the cancellation. Acceptable values are: - "`changedMind`" - "` + # orderedWrongItem`" - "`other`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason def initialize(**args) @@ -6506,29 +6146,22 @@ # class OrdersCreateTestOrderRequest include Google::Apis::Core::Hashable - # The CLDR territory code of the country of the test order to create. Affects + # The CLDR territory code of the country of the test order to create. Affects # the currency and addresses of orders created via `template_name`, or the - # addresses of orders created via `test_order`. - # Acceptable values are: - # - "`US`" - # - "`FR`" Defaults to `US`. + # addresses of orders created via `test_order`. Acceptable values are: - "`US`" - + # "`FR`" Defaults to `US`. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country # The test order template to use. Specify as an alternative to `testOrder` as a # shortcut for retrieving a template and then creating an order using that - # template. - # Acceptable values are: - # - "`template1`" - # - "`template1a`" - # - "`template1b`" - # - "`template2`" - # - "`template3`" + # template. Acceptable values are: - "`template1`" - "`template1a`" - "` + # template1b`" - "`template2`" - "`template3`" # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name # The test order to create. @@ -6671,26 +6304,15 @@ # getByMerchantOrderId` methods. # Corresponds to the JSON property `merchantOrderId` # @return [String] attr_accessor :merchant_order_id - # The method of the batch entry. - # Acceptable values are: - # - "`acknowledge`" - # - "`cancel`" - # - "`cancelLineItem`" - # - "`get`" - # - "`getByMerchantOrderId`" - # - "`inStoreRefundLineItem`" - # - "`refund`" - # - "`rejectReturnLineItem`" - # - "`returnLineItem`" - # - "`returnRefundLineItem`" - # - "`setLineItemMetadata`" - # - "`shipLineItems`" - # - "`updateLineItemShippingDetails`" - # - "`updateMerchantOrderId`" + # The method of the batch entry. Acceptable values are: - "`acknowledge`" - "` + # cancel`" - "`cancelLineItem`" - "`get`" - "`getByMerchantOrderId`" - "` + # inStoreRefundLineItem`" - "`refund`" - "`rejectReturnLineItem`" - "` + # returnLineItem`" - "`returnRefundLineItem`" - "`setLineItemMetadata`" - "` + # shipLineItems`" - "`updateLineItemShippingDetails`" - "`updateMerchantOrderId`" # - "`updateShipment`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -6773,22 +6395,14 @@ # class OrdersCustomBatchRequestEntryCancel include Google::Apis::Core::Hashable - # The reason for the cancellation. - # Acceptable values are: - # - "`customerInitiatedCancel`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`shippingPriceError`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" + # The reason for the cancellation. Acceptable values are: - "` + # customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - + # "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "` + # taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -6844,22 +6458,14 @@ # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the cancellation. - # Acceptable values are: - # - "`customerInitiatedCancel`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`shippingPriceError`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" + # The reason for the cancellation. Acceptable values are: - "` + # customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - + # "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "` + # taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -6937,25 +6543,17 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -6997,28 +6595,16 @@ # filled, amountPretax must be set. Calculated automatically if not provided. # Corresponds to the JSON property `amountTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :amount_tax - # The reason for the refund. - # Acceptable values are: - # - "`adjustment`" - # - "`courtesyAdjustment`" - # - "`customerCanceled`" - # - "`customerDiscretionaryReturn`" - # - "`deliveredLateByCarrier`" - # - "`feeAdjustment`" - # - "`lateShipmentCredit`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`shippingCostAdjustment`" - # - "`taxAdjustment`" - # - "`undeliverableShippingAddress`" - # - "`wrongProductShipped`" + # The reason for the refund. Acceptable values are: - "`adjustment`" - "` + # courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - + # "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "` + # noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "` + # undeliverableShippingAddress`" - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7058,17 +6644,12 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`damagedOrUsed`" - # - "`missingComponent`" - # - "`notEligible`" - # - "`other`" - # - "`outOfReturnWindow`" + # The reason for the return. Acceptable values are: - "`damagedOrUsed`" - "` + # missingComponent`" - "`notEligible`" - "`other`" - "`outOfReturnWindow`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7108,25 +6689,17 @@ # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7179,25 +6752,17 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7257,12 +6822,12 @@ # class OrdersCustomBatchRequestEntryShipLineItems include Google::Apis::Core::Hashable # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See `shipments[].carrier` in the Orders resource representation for a list - # of acceptable values. + # See `shipments[].carrier` in the Orders resource representation for a list of + # acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Line items to ship. @@ -7309,11 +6874,11 @@ # class OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo include Google::Apis::Core::Hashable - # The carrier handling the shipment. See `shipments[].carrier` in the Orders + # The carrier handling the shipment. See `shipments[].carrier` in the Orders # resource representation for a list of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -7343,13 +6908,12 @@ # class OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails include Google::Apis::Core::Hashable # Updated delivery by date, in ISO 8601 format. If not specified only ship by - # date is updated. - # Provided date should be within 1 year timeframe and can not be a date in the - # past. + # date is updated. Provided date should be within 1 year timeframe and can not + # be a date in the past. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date # The ID of the line item to set metadata. Either lineItemId or productId is @@ -7363,13 +6927,12 @@ # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Updated ship by date, in ISO 8601 format. If not specified only deliver by - # date is updated. - # Provided date should be within 1 year timeframe and can not be a date in the - # past. + # date is updated. Provided date should be within 1 year timeframe and can not + # be a date in the past. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date def initialize(**args) @@ -7388,12 +6951,11 @@ # class OrdersCustomBatchRequestEntryUpdateShipment include Google::Apis::Core::Hashable # The carrier handling the shipment. Not updated if missing. See `shipments[]. - # carrier` in the Orders resource representation for a list of acceptable - # values. + # carrier` in the Orders resource representation for a list of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been delivered, in ISO 8601 format. Optional @@ -7405,15 +6967,12 @@ # The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id - # New status for the shipment. Not updated if missing. - # Acceptable values are: - # - "`delivered`" - # - "`undeliverable`" - # - "`readyForPickup`" + # New status for the shipment. Not updated if missing. Acceptable values are: - " + # `delivered`" - "`undeliverable`" - "`readyForPickup`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking ID for the shipment. Not updated if missing. @@ -7473,17 +7032,13 @@ # A list of errors returned by a failed batch entry. # Corresponds to the JSON property `errors` # @return [Google::Apis::ContentV2::Errors] attr_accessor :errors - # The status of the execution. Only defined if - # - the request was successful; and - # - the method is not `get`, `getByMerchantOrderId`, or one of the test methods. - # - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Only defined if 1. the request was successful; + # and 2. the method is not `get`, `getByMerchantOrderId`, or one of the test + # methods. Acceptable values are: - "`duplicate`" - "`executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "`content# @@ -7491,12 +7046,11 @@ # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. - # orders ==) + # Sandbox access does not. # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order def initialize(**args) @@ -7522,12 +7076,11 @@ # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Order. Production access (all methods) requires the order manager role. - # Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1. - # orders ==) + # Sandbox access does not. # Corresponds to the JSON property `order` # @return [Google::Apis::ContentV2::Order] attr_accessor :order def initialize(**args) @@ -7600,25 +7153,17 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7645,14 +7190,12 @@ # class OrdersInStoreRefundLineItemResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -7727,28 +7270,16 @@ # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id - # The reason for the refund. - # Acceptable values are: - # - "`adjustment`" - # - "`courtesyAdjustment`" - # - "`customerCanceled`" - # - "`customerDiscretionaryReturn`" - # - "`deliveredLateByCarrier`" - # - "`feeAdjustment`" - # - "`lateShipmentCredit`" - # - "`noInventory`" - # - "`other`" - # - "`priceError`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`shippingCostAdjustment`" - # - "`taxAdjustment`" - # - "`undeliverableShippingAddress`" - # - "`wrongProductShipped`" + # The reason for the refund. Acceptable values are: - "`adjustment`" - "` + # courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - + # "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "` + # noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "` + # undeliverableShippingAddress`" - "`wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7773,14 +7304,12 @@ # class OrdersRefundResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -7823,17 +7352,12 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`damagedOrUsed`" - # - "`missingComponent`" - # - "`notEligible`" - # - "`other`" - # - "`outOfReturnWindow`" + # The reason for the return. Acceptable values are: - "`damagedOrUsed`" - "` + # missingComponent`" - "`notEligible`" - "`other`" - "`outOfReturnWindow`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7858,14 +7382,12 @@ # class OrdersRejectReturnLineItemResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -7908,25 +7430,17 @@ # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -7951,14 +7465,12 @@ # class OrdersReturnLineItemResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8014,25 +7526,17 @@ # The quantity to return and refund. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The reason for the return. - # Acceptable values are: - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`invalidCoupon`" - # - "`malformedShippingAddress`" - # - "`other`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`qualityNotAsExpected`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # The reason for the return. Acceptable values are: - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "` + # malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`qualityNotAsExpected`" - "` + # undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "` + # wrongProductShipped`" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason # The explanation of the reason. @@ -8059,14 +7563,12 @@ # class OrdersReturnRefundLineItemResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8127,14 +7629,12 @@ # class OrdersSetLineItemMetadataResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8157,12 +7657,12 @@ # class OrdersShipLineItemsRequest include Google::Apis::Core::Hashable # Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. - # See `shipments[].carrier` in the Orders resource representation for a list - # of acceptable values. + # See `shipments[].carrier` in the Orders resource representation for a list of + # acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Line items to ship. @@ -8215,14 +7715,12 @@ # class OrdersShipLineItemsResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8245,13 +7743,12 @@ # class OrdersUpdateLineItemShippingDetailsRequest include Google::Apis::Core::Hashable # Updated delivery by date, in ISO 8601 format. If not specified only ship by - # date is updated. - # Provided date should be within 1 year timeframe and can not be a date in the - # past. + # date is updated. Provided date should be within 1 year timeframe and can not + # be a date in the past. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date # The ID of the line item to set metadata. Either lineItemId or productId is @@ -8270,13 +7767,12 @@ # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Updated ship by date, in ISO 8601 format. If not specified only deliver by - # date is updated. - # Provided date should be within 1 year timeframe and can not be a date in the - # past. + # date is updated. Provided date should be within 1 year timeframe and can not + # be a date in the past. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date def initialize(**args) @@ -8295,14 +7791,12 @@ # class OrdersUpdateLineItemShippingDetailsResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8349,14 +7843,12 @@ # class OrdersUpdateMerchantOrderIdResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8379,12 +7871,11 @@ # class OrdersUpdateShipmentRequest include Google::Apis::Core::Hashable # The carrier handling the shipment. Not updated if missing. See `shipments[]. - # carrier` in the Orders resource representation for a list of acceptable - # values. + # carrier` in the Orders resource representation for a list of acceptable values. # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # Date on which the shipment has been delivered, in ISO 8601 format. Optional @@ -8401,15 +7892,12 @@ # The ID of the shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id - # New status for the shipment. Not updated if missing. - # Acceptable values are: - # - "`delivered`" - # - "`undeliverable`" - # - "`readyForPickup`" + # New status for the shipment. Not updated if missing. Acceptable values are: - " + # `delivered`" - "`undeliverable`" - "`readyForPickup`" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The tracking ID for the shipment. Not updated if missing. @@ -8434,14 +7922,12 @@ # class OrdersUpdateShipmentResponse include Google::Apis::Core::Hashable - # The status of the execution. - # Acceptable values are: - # - "`duplicate`" - # - "`executed`" + # The status of the execution. Acceptable values are: - "`duplicate`" - "` + # executed`" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status # Identifies what kind of resource this is. Value: the fixed string "content# @@ -8553,17 +8039,12 @@ # The ID of the POS data provider. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`delete`" - # - "`get`" - # - "`insert`" - # - "`inventory`" - # - "`sale`" + # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - + # "`insert`" - "`inventory`" - "`sale`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The change of the available quantity of an item at the given store. @@ -9303,16 +8784,15 @@ @value = args[:value] if args.key?(:value) end end # Required product attributes are primarily defined by the products data - # specification. See the Products Data Specification Help Center article for - # information. - # Some attributes are country-specific, so make sure you select the appropriate - # country in the drop-down selector at the top of the page. - # Product data. After inserting, updating, or deleting a product, it may take - # several minutes before changes take effect. + # specification. See the Products Data Specification Help Center article for + # information. Some attributes are country-specific, so make sure you select the + # appropriate country in the drop-down selector at the top of the page. Product + # data. After inserting, updating, or deleting a product, it may take several + # minutes before changes take effect. class Product include Google::Apis::Core::Hashable # Additional URLs of images of the item. # Corresponds to the JSON property `additionalImageLinks` @@ -9345,32 +8825,23 @@ # the context of Product Ads. # Corresponds to the JSON property `adwordsRedirect` # @return [String] attr_accessor :adwords_redirect - # Target age group of the item. - # Acceptable values are: - # - "`adult`" - # - "`infant`" - # - "`kids`" - # - "`newborn`" - # - "`toddler`" - # - "`youngAdult`" + # Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - + # "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`" # Corresponds to the JSON property `ageGroup` # @return [String] attr_accessor :age_group # Deprecated. Do not use. # Corresponds to the JSON property `aspects` # @return [Array<Google::Apis::ContentV2::ProductAspect>] attr_accessor :aspects - # Availability status of the item. - # Acceptable values are: - # - "`in stock`" - # - "`out of stock`" - # - "`preorder`" + # Availability status of the item. Acceptable values are: - "`in stock`" - "`out + # of stock`" - "`preorder`" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability # The day a pre-ordered product becomes available for delivery, in ISO 8601 @@ -9387,27 +8858,23 @@ # URL for the canonical version of your item's landing page. # Corresponds to the JSON property `canonicalLink` # @return [String] attr_accessor :canonical_link - # Required. The item's channel (online or local). - # Acceptable values are: - # - "`local`" - # - "`online`" + # Required. The item's channel (online or local). Acceptable values are: - "` + # local`" - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Color of the item. # Corresponds to the JSON property `color` # @return [String] attr_accessor :color - # Condition or state of the item. - # Acceptable values are: - # - "`local`" - # - "`online`" + # Condition or state of the item. Acceptable values are: - "`local`" - "`online`" + # # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition # Required. The two-letter ISO 639-1 language code for the item. @@ -9492,22 +8959,13 @@ # Offer margin for dynamic remarketing campaigns. # Corresponds to the JSON property `displayAdsValue` # @return [Float] attr_accessor :display_ads_value - # The energy efficiency class as defined in EU directive 2010/30/EU. - # Acceptable values are: - # - "`A`" - # - "`A+`" - # - "`A++`" - # - "`A+++`" - # - "`B`" - # - "`C`" - # - "`D`" - # - "`E`" - # - "`F`" - # - "`G`" + # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable + # values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "` + # E`" - "`F`" - "`G`" # Corresponds to the JSON property `energyEfficiencyClass` # @return [String] attr_accessor :energy_efficiency_class # Date on which the item should expire, as specified upon insertion, in ISO 8601 @@ -9516,15 +8974,12 @@ # expirationDate` is too far in the future. # Corresponds to the JSON property `expirationDate` # @return [String] attr_accessor :expiration_date - # Target gender of the item. - # Acceptable values are: - # - "`female`" - # - "`male`" - # - "`unisex`" + # Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "` + # unisex`" # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender # Google's category of the item (see Google product taxonomy). @@ -9536,13 +8991,12 @@ # Corresponds to the JSON property `gtin` # @return [String] attr_accessor :gtin # The REST ID of the product. Content API methods that operate on products take - # this as their `productId` parameter. - # The REST ID for a product is of the form channel:contentLanguage:targetCountry: - # offerId. + # this as their `productId` parameter. The REST ID for a product is of the form + # channel:contentLanguage: targetCountry: offerId. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # False when the item does not have unique product identifiers appropriate to @@ -9594,43 +9048,25 @@ # The material of which the item is made. # Corresponds to the JSON property `material` # @return [String] attr_accessor :material - # The energy efficiency class as defined in EU directive 2010/30/EU. - # Acceptable values are: - # - "`A`" - # - "`A+`" - # - "`A++`" - # - "`A+++`" - # - "`B`" - # - "`C`" - # - "`D`" - # - "`E`" - # - "`F`" - # - "`G`" + # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable + # values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "` + # E`" - "`F`" - "`G`" # Corresponds to the JSON property `maxEnergyEfficiencyClass` # @return [String] attr_accessor :max_energy_efficiency_class # Maximal product handling time (in business days). # Corresponds to the JSON property `maxHandlingTime` # @return [Fixnum] attr_accessor :max_handling_time - # The energy efficiency class as defined in EU directive 2010/30/EU. - # Acceptable values are: - # - "`A`" - # - "`A+`" - # - "`A++`" - # - "`A+++`" - # - "`B`" - # - "`C`" - # - "`D`" - # - "`E`" - # - "`F`" - # - "`G`" + # The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable + # values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "` + # E`" - "`F`" - "`G`" # Corresponds to the JSON property `minEnergyEfficiencyClass` # @return [String] attr_accessor :min_energy_efficiency_class # Minimal product handling time (in business days). @@ -9654,13 +9090,12 @@ attr_accessor :multipack # Required. A unique identifier for the item. Leading and trailing whitespaces # are stripped and multiple whitespaces are replaced by a single whitespace upon # submission. Only valid unicode characters are accepted. See the products feed - # specification for details. - # Note: Content API methods that operate on products take the REST ID of the - # product, not this identifier. + # specification for details. *Note:* Content API methods that operate on + # products take the REST ID of the product, *not* this identifier. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id # Deprecated. @@ -9692,11 +9127,11 @@ # Advertised sale price of the item. # Corresponds to the JSON property `salePrice` # @return [Google::Apis::ContentV2::Price] attr_accessor :sale_price - # Date range during which the item is on sale (see products data specification). + # Date range during which the item is on sale (see products data specification ). # Corresponds to the JSON property `salePriceEffectiveDate` # @return [String] attr_accessor :sale_price_effective_date # The quantity of the product that is available for selling on Google. Supported @@ -9735,34 +9170,19 @@ # Corresponds to the JSON property `shippingWidth` # @return [Google::Apis::ContentV2::ProductShippingDimension] attr_accessor :shipping_width # System in which the size is specified. Recommended for apparel items. - # Acceptable values are: - # - "`AU`" - # - "`BR`" - # - "`CN`" - # - "`DE`" - # - "`EU`" - # - "`FR`" - # - "`IT`" - # - "`JP`" - # - "`MEX`" - # - "`UK`" - # - "`US`" + # Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - + # "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`" # Corresponds to the JSON property `sizeSystem` # @return [String] attr_accessor :size_system - # The cut of the item. Recommended for apparel items. - # Acceptable values are: - # - "`big and tall`" - # - "`maternity`" - # - "`oversize`" - # - "`petite`" - # - "`plus`" - # - "`regular`" + # The cut of the item. Recommended for apparel items. Acceptable values are: - "` + # big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "` + # regular`" # Corresponds to the JSON property `sizeType` # @return [String] attr_accessor :size_type # Size of the item. Only one value is allowed. For variants with different sizes, @@ -9770,15 +9190,12 @@ # see size definition). # Corresponds to the JSON property `sizes` # @return [Array<String>] attr_accessor :sizes - # The source of the offer, i.e., how the offer was created. - # Acceptable values are: - # - "`api`" - # - "`crawl`" - # - "`feed`" + # The source of the offer, i.e., how the offer was created. Acceptable values + # are: - "`api`" - "`crawl`" - "`feed`" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Required. The CLDR territory code for the item. @@ -9975,15 +9392,12 @@ # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name # Whether the destination is required, excluded or should be validated. - # Acceptable values are: - # - "`default`" - # - "`excluded`" - # - "`optional`" - # - "`required`" + # Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "` + # required`" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention def initialize(**args) @@ -10151,16 +9565,15 @@ # Corresponds to the JSON property `link` # @return [String] attr_accessor :link # Required product attributes are primarily defined by the products data - # specification. See the Products Data Specification Help Center article for - # information. - # Some attributes are country-specific, so make sure you select the appropriate - # country in the drop-down selector at the top of the page. - # Product data. After inserting, updating, or deleting a product, it may take - # several minutes before changes take effect. + # specification. See the Products Data Specification Help Center article for + # information. Some attributes are country-specific, so make sure you select the + # appropriate country in the drop-down selector at the top of the page. Product + # data. After inserting, updating, or deleting a product, it may take several + # minutes before changes take effect. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product # The ID of the product for which status is reported. @@ -10268,29 +9681,23 @@ # Corresponds to the JSON property `approvalPending` # @return [Boolean] attr_accessor :approval_pending alias_method :approval_pending?, :approval_pending - # The destination's approval status. - # Acceptable values are: - # - "`approved`" - # - "`disapproved`" + # The destination's approval status. Acceptable values are: - "`approved`" - "` + # disapproved`" # Corresponds to the JSON property `approvalStatus` # @return [String] attr_accessor :approval_status # The name of the destination # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination - # Provided for backward compatibility only. Always set to "required". - # Acceptable values are: - # - "`default`" - # - "`excluded`" - # - "`optional`" - # - "`required`" + # Provided for backward compatibility only. Always set to "required". Acceptable + # values are: - "`default`" - "`excluded`" - "`optional`" - "`required`" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention def initialize(**args) @@ -10501,26 +9908,22 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`delete`" - # - "`get`" - # - "`insert`" + # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - + # "`insert`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # Required product attributes are primarily defined by the products data - # specification. See the Products Data Specification Help Center article for - # information. - # Some attributes are country-specific, so make sure you select the appropriate - # country in the drop-down selector at the top of the page. - # Product data. After inserting, updating, or deleting a product, it may take - # several minutes before changes take effect. + # specification. See the Products Data Specification Help Center article for + # information. Some attributes are country-specific, so make sure you select the + # appropriate country in the drop-down selector at the top of the page. Product + # data. After inserting, updating, or deleting a product, it may take several + # minutes before changes take effect. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product # The ID of the product to get or delete. Only defined if the method is `get` or @@ -10588,16 +9991,15 @@ # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Required product attributes are primarily defined by the products data - # specification. See the Products Data Specification Help Center article for - # information. - # Some attributes are country-specific, so make sure you select the appropriate - # country in the drop-down selector at the top of the page. - # Product data. After inserting, updating, or deleting a product, it may take - # several minutes before changes take effect. + # specification. See the Products Data Specification Help Center article for + # information. Some attributes are country-specific, so make sure you select the + # appropriate country in the drop-down selector at the top of the page. Product + # data. After inserting, updating, or deleting a product, it may take several + # minutes before changes take effect. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::Product] attr_accessor :product def initialize(**args) @@ -10688,13 +10090,11 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" + # The method of the batch entry. Acceptable values are: - "`get`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method # The ID of the product whose status to get. @@ -10905,56 +10305,27 @@ # Description of the reason. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Code of the refund reason. - # Acceptable values are: - # - "`adjustment`" - # - "`autoPostInternal`" - # - "`autoPostInvalidBillingAddress`" - # - "`autoPostNoInventory`" - # - "`autoPostPriceError`" - # - "`autoPostUndeliverableShippingAddress`" - # - "`couponAbuse`" - # - "`courtesyAdjustment`" - # - "`customerCanceled`" - # - "`customerDiscretionaryReturn`" - # - "`customerInitiatedMerchantCancel`" - # - "`customerSupportRequested`" - # - "`deliveredLateByCarrier`" - # - "`deliveredTooLate`" - # - "`expiredItem`" - # - "`failToPushOrderGoogleError`" - # - "`failToPushOrderMerchantError`" - # - "`failToPushOrderMerchantFulfillmentError`" - # - "`failToPushOrderToMerchant`" - # - "`failToPushOrderToMerchantOutOfStock`" - # - "`feeAdjustment`" - # - "`invalidCoupon`" - # - "`lateShipmentCredit`" - # - "`malformedShippingAddress`" - # - "`merchantDidNotShipOnTime`" - # - "`noInventory`" - # - "`orderTimeout`" - # - "`other`" - # - "`paymentAbuse`" - # - "`paymentDeclined`" - # - "`priceAdjustment`" - # - "`priceError`" - # - "`productArrivedDamaged`" - # - "`productNotAsDescribed`" - # - "`promoReallocation`" - # - "`qualityNotAsExpected`" - # - "`returnRefundAbuse`" - # - "`shippingCostAdjustment`" - # - "`shippingPriceError`" - # - "`taxAdjustment`" - # - "`taxError`" - # - "`undeliverableShippingAddress`" - # - "`unsupportedPoBoxAddress`" - # - "`wrongProductShipped`" + # Code of the refund reason. Acceptable values are: - "`adjustment`" - "` + # autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory` + # " - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "` + # couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "` + # customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "` + # customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" + # - "`expiredItem`" - "`failToPushOrderGoogleError`" - "` + # failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - + # "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "` + # feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "` + # malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - " + # `orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "` + # priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "` + # productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "` + # returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "` + # taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "` + # unsupportedPoBoxAddress`" - "`wrongProductShipped`" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code def initialize(**args) @@ -10980,15 +10351,12 @@ # The date of delivery of the shipment, in ISO 8601 format. # Corresponds to the JSON property `deliveryDate` # @return [String] attr_accessor :delivery_date - # Type of the return method. - # Acceptable values are: - # - "`byMail`" - # - "`contactCustomerSupport`" - # - "`returnless`" + # Type of the return method. Acceptable values are: - "`byMail`" - "` + # contactCustomerSupport`" - "`returnless`" # Corresponds to the JSON property `returnMethodType` # @return [String] attr_accessor :return_method_type # Shipment ID generated by Google. @@ -11005,17 +10373,12 @@ # The date of shipping of the shipment, in ISO 8601 format. # Corresponds to the JSON property `shippingDate` # @return [String] attr_accessor :shipping_date - # State of the shipment. - # Acceptable values are: - # - "`completed`" - # - "`new`" - # - "`shipped`" - # - "`undeliverable`" - # - "`pending`" + # State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "` + # shipped`" - "`undeliverable`" - "`pending`" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) @@ -11080,15 +10443,12 @@ # Required. # Corresponds to the JSON property `deliveryTime` # @return [Google::Apis::ContentV2::DeliveryTime] attr_accessor :delivery_time - # Eligibility for this service. - # Acceptable values are: - # - "`All scenarios`" - # - "`All scenarios except Shopping Actions`" - # - "`Shopping Actions`" + # Eligibility for this service. Acceptable values are: - "`All scenarios`" - "` + # All scenarios except Shopping Actions`" - "`Shopping Actions`" # Corresponds to the JSON property `eligibility` # @return [String] attr_accessor :eligibility # Minimum order value for this service. If set, indicates that customers will @@ -11121,14 +10481,12 @@ # applicableShippingLabels` must not overlap. # Corresponds to the JSON property `rateGroups` # @return [Array<Google::Apis::ContentV2::RateGroup>] attr_accessor :rate_groups - # Type of locations this service ships orders to. - # Acceptable values are: - # - "`delivery`" - # - "`pickup`" + # Type of locations this service ships orders to. Acceptable values are: - "` + # delivery`" - "`pickup`" # Corresponds to the JSON property `shipmentType` # @return [String] attr_accessor :shipment_type def initialize(**args) @@ -11227,42 +10585,17 @@ # class ShipmentTrackingInfo include Google::Apis::Core::Hashable - # The shipping carrier that handles the package. - # Acceptable values are: - # - "`boxtal`" - # - "`bpost`" - # - "`chronopost`" - # - "`colisPrive`" - # - "`colissimo`" - # - "`cxt`" - # - "`deliv`" - # - "`dhl`" - # - "`dpd`" - # - "`dynamex`" - # - "`eCourier`" - # - "`easypost`" - # - "`efw`" - # - "`fedex`" - # - "`fedexSmartpost`" - # - "`geodis`" - # - "`gls`" - # - "`googleCourier`" - # - "`gsx`" - # - "`jdLogistics`" - # - "`laPoste`" - # - "`lasership`" - # - "`manual`" - # - "`mpx`" - # - "`onTrac`" - # - "`other`" - # - "`tnt`" - # - "`uds`" - # - "`ups`" - # - "`usps`" + # The shipping carrier that handles the package. Acceptable values are: - "` + # boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt` + # " - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - + # "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "` + # googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "` + # manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "` + # usps`" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier # The tracking number for the package. @@ -11350,14 +10683,11 @@ # The ID of the managing account. # Corresponds to the JSON property `merchantId` # @return [Fixnum] attr_accessor :merchant_id - # The method of the batch entry. - # Acceptable values are: - # - "`get`" - # - "`update`" + # The method of the batch entry. Acceptable values are: - "`get`" - "`update`" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop # The merchant account's shipping settings. All methods except @@ -11630,25 +10960,18 @@ # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2::TestOrderPaymentMethod] attr_accessor :payment_method # Required. Identifier of one of the predefined delivery addresses for the - # delivery. - # Acceptable values are: - # - "`dwight`" - # - "`jim`" - # - "`pam`" + # delivery. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address # Identifier of one of the predefined pickup details. Required for orders - # containing line items with shipping type `pickup`. - # Acceptable values are: - # - "`dwight`" - # - "`jim`" - # - "`pam`" + # containing line items with shipping type `pickup`. Acceptable values are: - "` + # dwight`" - "`jim`" - "`pam`" # Corresponds to the JSON property `predefinedPickupDetails` # @return [String] attr_accessor :predefined_pickup_details # Deprecated. Ignored if provided. @@ -11667,18 +10990,12 @@ # Deprecated. Ignored if provided. # Corresponds to the JSON property `shippingCostTax` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost_tax - # Required. The requested shipping option. - # Acceptable values are: - # - "`economy`" - # - "`expedited`" - # - "`oneDay`" - # - "`sameDay`" - # - "`standard`" - # - "`twoDay`" + # Required. The requested shipping option. Acceptable values are: - "`economy`" - + # "`expedited`" - "`oneDay`" - "`sameDay`" - "`standard`" - "`twoDay`" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option def initialize(**args) @@ -11704,15 +11021,13 @@ # class TestOrderCustomer include Google::Apis::Core::Hashable - # Required. Email address of the customer. - # Acceptable values are: - # - "`pog.dwight.schrute@gmail.com`" - # - "`pog.jim.halpert@gmail.com`" - # - "`penpog.pam.beesly@gmail.comding`" + # Required. Email address of the customer. Acceptable values are: - "`pog.dwight. + # schrute@gmail.com`" - "`pog.jim.halpert@gmail.com`" - "`penpog.pam.beesly@ + # gmail.comding`" # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # Deprecated. Please use marketingRightsInfo instead. @@ -11747,14 +11062,12 @@ # class TestOrderCustomerMarketingRightsInfo include Google::Apis::Core::Hashable # Last know user use selection regards marketing preferences. In certain cases - # selection might not be known, so this field would be empty. - # Acceptable values are: - # - "`denied`" - # - "`granted`" + # selection might not be known, so this field would be empty. Acceptable values + # are: - "`denied`" - "`granted`" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference # Timestamp when last time marketing preference was updated. Could be empty, if @@ -11824,28 +11137,22 @@ # Required. Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand - # Deprecated. - # Acceptable values are: - # - "`online`" + # Deprecated. Acceptable values are: - "`online`" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel - # Required. Condition or state of the item. - # Acceptable values are: - # - "`new`" + # Required. Condition or state of the item. Acceptable values are: - "`new`" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition - # Required. The two-letter ISO 639-1 language code for the item. - # Acceptable values are: - # - "`en`" - # - "`fr`" + # Required. The two-letter ISO 639-1 language code for the item. Acceptable + # values are: - "`en`" - "`fr`" # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language # Fees for the item. Optional. @@ -11883,11 +11190,11 @@ # settings from Merchant Center are applied. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # Required. The CLDR territory code of the target country of the product. + # Required. The CLDR territory // code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country # Required. The title of the product. @@ -11940,26 +11247,18 @@ # The last four digits of the card number. # Corresponds to the JSON property `lastFourDigits` # @return [String] attr_accessor :last_four_digits - # The billing address. - # Acceptable values are: - # - "`dwight`" - # - "`jim`" - # - "`pam`" + # The billing address. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" # Corresponds to the JSON property `predefinedBillingAddress` # @return [String] attr_accessor :predefined_billing_address # The type of instrument. Note that real orders might have different values than - # the four values accepted by `createTestOrder`. - # Acceptable values are: - # - "`AMEX`" - # - "`DISCOVER`" - # - "`MASTERCARD`" - # - "`VISA`" + # the four values accepted by `createTestOrder`. Acceptable values are: - "`AMEX` + # " - "`DISCOVER`" - "`MASTERCARD`" - "`VISA`" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -12104,13 +11403,12 @@ # Deprecated. # Corresponds to the JSON property `additionalChargePromotions` # @return [Array<Google::Apis::ContentV2::Promotion>] attr_accessor :additional_charge_promotions - # [required] Type of the additional charge. - # Acceptable values are: - # - "`shipping`" + # [required] Type of the additional charge. Acceptable values are: - "`shipping`" + # # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -12138,15 +11436,12 @@ # otherFeeTax`. # Corresponds to the JSON property `taxName` # @return [String] attr_accessor :tax_name - # [required] Type of the tax. - # Acceptable values are: - # - "`otherFee`" - # - "`otherFeeTax`" - # - "`sales`" + # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "` + # otherFeeTax`" - "`sales`" # Corresponds to the JSON property `taxType` # @return [String] attr_accessor :tax_type def initialize(**args) @@ -12213,13 +11508,10 @@ # class Weight include Google::Apis::Core::Hashable - # Required. The weight unit. - # Acceptable values are: - # - "`kg`" - # - "`lb`" + # Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Required. The weight represented as a number.