google-apis-content_v2_1 0.31.0 → 0.32.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -76,7 +76,8 @@ module Google
76
76
  execute_or_queue_command(command, &block)
77
77
  end
78
78
 
79
- # Claims the website of a Merchant Center sub-account.
79
+ # Claims the website of a Merchant Center sub-account. Merchant accounts with
80
+ # approved third-party CSSs aren't required to claim a website.
80
81
  # @param [Fixnum] merchant_id
81
82
  # The ID of the managing account. If this parameter is not the same as accountId,
82
83
  # then this account must be a multi-client account and `accountId` must be the
@@ -85,7 +86,7 @@ module Google
85
86
  # The ID of the account whose website is claimed.
86
87
  # @param [Boolean] overwrite
87
88
  # Only available to selected merchants, for example multi-client accounts (MCAs)
88
- # and their sub-accounts. When set to `True`, this flag removes any existing
89
+ # and their sub-accounts. When set to `True`, this option removes any existing
89
90
  # claim on the requested website and replaces it with a claim from the account
90
91
  # that makes the request.
91
92
  # @param [String] fields
@@ -155,7 +156,7 @@ module Google
155
156
  # @param [Fixnum] account_id
156
157
  # The ID of the account.
157
158
  # @param [Boolean] force
158
- # Flag to delete sub-accounts with products. The default value is false.
159
+ # Option to delete sub-accounts with products. The default value is false.
159
160
  # @param [String] fields
160
161
  # Selector specifying which fields to include in a partial response.
161
162
  # @param [String] quota_user
@@ -1104,8 +1105,8 @@ module Google
1104
1105
  end
1105
1106
 
1106
1107
  # Reactivates the BoG program in your Merchant Center account. Moves the program
1107
- # to the active state when allowed, e.g. when paused. Important: This method is
1108
- # only whitelisted for selected merchants.
1108
+ # to the active state when allowed, for example, when paused. This method is
1109
+ # only available to selected merchants.
1109
1110
  # @param [Fixnum] merchant_id
1110
1111
  # Required. The ID of the account.
1111
1112
  # @param [String] region_code
@@ -1256,8 +1257,8 @@ module Google
1256
1257
  execute_or_queue_command(command, &block)
1257
1258
  end
1258
1259
 
1259
- # Pauses the BoG program in your Merchant Center account. Important: This method
1260
- # is only whitelisted for selected merchants.
1260
+ # Pauses the BoG program in your Merchant Center account. This method is only
1261
+ # available to selected merchants.
1261
1262
  # @param [Fixnum] merchant_id
1262
1263
  # Required. The ID of the account.
1263
1264
  # @param [String] region_code
@@ -1294,7 +1295,7 @@ module Google
1294
1295
 
1295
1296
  # Requests review and then activates the BoG program in your Merchant Center
1296
1297
  # account for the first time. Moves the program to the REVIEW_PENDING state.
1297
- # Important: This method is only whitelisted for selected merchants.
1298
+ # This method is only available to selected merchants.
1298
1299
  # @param [Fixnum] merchant_id
1299
1300
  # Required. The ID of the account.
1300
1301
  # @param [String] region_code
@@ -1548,6 +1549,220 @@ module Google
1548
1549
  execute_or_queue_command(command, &block)
1549
1550
  end
1550
1551
 
1552
+ # Creates a new conversion source.
1553
+ # @param [Fixnum] merchant_id
1554
+ # Required. The ID of the account that owns the new conversion source.
1555
+ # @param [Google::Apis::ContentV2_1::ConversionSource] conversion_source_object
1556
+ # @param [String] fields
1557
+ # Selector specifying which fields to include in a partial response.
1558
+ # @param [String] quota_user
1559
+ # Available to use for quota purposes for server-side applications. Can be any
1560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1561
+ # @param [Google::Apis::RequestOptions] options
1562
+ # Request-specific options
1563
+ #
1564
+ # @yield [result, err] Result & error if block supplied
1565
+ # @yieldparam result [Google::Apis::ContentV2_1::ConversionSource] parsed result object
1566
+ # @yieldparam err [StandardError] error object if request failed
1567
+ #
1568
+ # @return [Google::Apis::ContentV2_1::ConversionSource]
1569
+ #
1570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1573
+ def create_conversionsource(merchant_id, conversion_source_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1574
+ command = make_simple_command(:post, '{merchantId}/conversionsources', options)
1575
+ command.request_representation = Google::Apis::ContentV2_1::ConversionSource::Representation
1576
+ command.request_object = conversion_source_object
1577
+ command.response_representation = Google::Apis::ContentV2_1::ConversionSource::Representation
1578
+ command.response_class = Google::Apis::ContentV2_1::ConversionSource
1579
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1580
+ command.query['fields'] = fields unless fields.nil?
1581
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1582
+ execute_or_queue_command(command, &block)
1583
+ end
1584
+
1585
+ # Archives an existing conversion source. It will be recoverable for 30 days.
1586
+ # This archiving behavior is not typical in the Content API and unique to this
1587
+ # service.
1588
+ # @param [Fixnum] merchant_id
1589
+ # Required. The ID of the account that owns the new conversion source.
1590
+ # @param [String] conversion_source_id
1591
+ # Required. The ID of the conversion source to be deleted.
1592
+ # @param [String] fields
1593
+ # Selector specifying which fields to include in a partial response.
1594
+ # @param [String] quota_user
1595
+ # Available to use for quota purposes for server-side applications. Can be any
1596
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1597
+ # @param [Google::Apis::RequestOptions] options
1598
+ # Request-specific options
1599
+ #
1600
+ # @yield [result, err] Result & error if block supplied
1601
+ # @yieldparam result [NilClass] No result returned for this method
1602
+ # @yieldparam err [StandardError] error object if request failed
1603
+ #
1604
+ # @return [void]
1605
+ #
1606
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1607
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1608
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1609
+ def delete_conversionsource(merchant_id, conversion_source_id, fields: nil, quota_user: nil, options: nil, &block)
1610
+ command = make_simple_command(:delete, '{merchantId}/conversionsources/{conversionSourceId}', options)
1611
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1612
+ command.params['conversionSourceId'] = conversion_source_id unless conversion_source_id.nil?
1613
+ command.query['fields'] = fields unless fields.nil?
1614
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1615
+ execute_or_queue_command(command, &block)
1616
+ end
1617
+
1618
+ # Fetches a conversion source.
1619
+ # @param [Fixnum] merchant_id
1620
+ # Required. The ID of the account that owns the new conversion source.
1621
+ # @param [String] conversion_source_id
1622
+ # Required. The REST ID of the collection.
1623
+ # @param [String] fields
1624
+ # Selector specifying which fields to include in a partial response.
1625
+ # @param [String] quota_user
1626
+ # Available to use for quota purposes for server-side applications. Can be any
1627
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1628
+ # @param [Google::Apis::RequestOptions] options
1629
+ # Request-specific options
1630
+ #
1631
+ # @yield [result, err] Result & error if block supplied
1632
+ # @yieldparam result [Google::Apis::ContentV2_1::ConversionSource] parsed result object
1633
+ # @yieldparam err [StandardError] error object if request failed
1634
+ #
1635
+ # @return [Google::Apis::ContentV2_1::ConversionSource]
1636
+ #
1637
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1638
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1639
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1640
+ def get_conversionsource(merchant_id, conversion_source_id, fields: nil, quota_user: nil, options: nil, &block)
1641
+ command = make_simple_command(:get, '{merchantId}/conversionsources/{conversionSourceId}', options)
1642
+ command.response_representation = Google::Apis::ContentV2_1::ConversionSource::Representation
1643
+ command.response_class = Google::Apis::ContentV2_1::ConversionSource
1644
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1645
+ command.params['conversionSourceId'] = conversion_source_id unless conversion_source_id.nil?
1646
+ command.query['fields'] = fields unless fields.nil?
1647
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1648
+ execute_or_queue_command(command, &block)
1649
+ end
1650
+
1651
+ # Retrieves the list of conversion sources the caller has access to.
1652
+ # @param [Fixnum] merchant_id
1653
+ # Required. The ID of the account that owns the new conversion source.
1654
+ # @param [Fixnum] page_size
1655
+ # The maximum number of conversion sources to return in a page. If no `page_size`
1656
+ # is specified, `100` is used as the default value. The maximum value is `200`.
1657
+ # Values above `200` will be coerced to `200`. Regardless of pagination, at most
1658
+ # `200` conversion sources are returned in total.
1659
+ # @param [String] page_token
1660
+ # Page token.
1661
+ # @param [Boolean] show_deleted
1662
+ # If true, also returns archived conversion sources.
1663
+ # @param [String] fields
1664
+ # Selector specifying which fields to include in a partial response.
1665
+ # @param [String] quota_user
1666
+ # Available to use for quota purposes for server-side applications. Can be any
1667
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1668
+ # @param [Google::Apis::RequestOptions] options
1669
+ # Request-specific options
1670
+ #
1671
+ # @yield [result, err] Result & error if block supplied
1672
+ # @yieldparam result [Google::Apis::ContentV2_1::ListConversionSourcesResponse] parsed result object
1673
+ # @yieldparam err [StandardError] error object if request failed
1674
+ #
1675
+ # @return [Google::Apis::ContentV2_1::ListConversionSourcesResponse]
1676
+ #
1677
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1678
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1679
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1680
+ def list_conversionsources(merchant_id, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
1681
+ command = make_simple_command(:get, '{merchantId}/conversionsources', options)
1682
+ command.response_representation = Google::Apis::ContentV2_1::ListConversionSourcesResponse::Representation
1683
+ command.response_class = Google::Apis::ContentV2_1::ListConversionSourcesResponse
1684
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1685
+ command.query['pageSize'] = page_size unless page_size.nil?
1686
+ command.query['pageToken'] = page_token unless page_token.nil?
1687
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
1688
+ command.query['fields'] = fields unless fields.nil?
1689
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1690
+ execute_or_queue_command(command, &block)
1691
+ end
1692
+
1693
+ # Updates information of an existing conversion source.
1694
+ # @param [Fixnum] merchant_id
1695
+ # Required. The ID of the account that owns the new conversion source.
1696
+ # @param [String] conversion_source_id
1697
+ # Required. The ID of the conversion source to be updated.
1698
+ # @param [Google::Apis::ContentV2_1::ConversionSource] conversion_source_object
1699
+ # @param [String] update_mask
1700
+ # Required. List of fields being updated.
1701
+ # @param [String] fields
1702
+ # Selector specifying which fields to include in a partial response.
1703
+ # @param [String] quota_user
1704
+ # Available to use for quota purposes for server-side applications. Can be any
1705
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1706
+ # @param [Google::Apis::RequestOptions] options
1707
+ # Request-specific options
1708
+ #
1709
+ # @yield [result, err] Result & error if block supplied
1710
+ # @yieldparam result [Google::Apis::ContentV2_1::ConversionSource] parsed result object
1711
+ # @yieldparam err [StandardError] error object if request failed
1712
+ #
1713
+ # @return [Google::Apis::ContentV2_1::ConversionSource]
1714
+ #
1715
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1716
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1717
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1718
+ def patch_conversionsource(merchant_id, conversion_source_id, conversion_source_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1719
+ command = make_simple_command(:patch, '{merchantId}/conversionsources/{conversionSourceId}', options)
1720
+ command.request_representation = Google::Apis::ContentV2_1::ConversionSource::Representation
1721
+ command.request_object = conversion_source_object
1722
+ command.response_representation = Google::Apis::ContentV2_1::ConversionSource::Representation
1723
+ command.response_class = Google::Apis::ContentV2_1::ConversionSource
1724
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1725
+ command.params['conversionSourceId'] = conversion_source_id unless conversion_source_id.nil?
1726
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1727
+ command.query['fields'] = fields unless fields.nil?
1728
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1729
+ execute_or_queue_command(command, &block)
1730
+ end
1731
+
1732
+ # Re-enables an archived conversion source.
1733
+ # @param [Fixnum] merchant_id
1734
+ # Required. The ID of the account that owns the new conversion source.
1735
+ # @param [String] conversion_source_id
1736
+ # Required. The ID of the conversion source to be undeleted.
1737
+ # @param [Google::Apis::ContentV2_1::UndeleteConversionSourceRequest] undelete_conversion_source_request_object
1738
+ # @param [String] fields
1739
+ # Selector specifying which fields to include in a partial response.
1740
+ # @param [String] quota_user
1741
+ # Available to use for quota purposes for server-side applications. Can be any
1742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1743
+ # @param [Google::Apis::RequestOptions] options
1744
+ # Request-specific options
1745
+ #
1746
+ # @yield [result, err] Result & error if block supplied
1747
+ # @yieldparam result [NilClass] No result returned for this method
1748
+ # @yieldparam err [StandardError] error object if request failed
1749
+ #
1750
+ # @return [void]
1751
+ #
1752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1755
+ def undelete_conversionsource_conversion_source(merchant_id, conversion_source_id, undelete_conversion_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1756
+ command = make_simple_command(:post, '{merchantId}/conversionsources/{conversionSourceId}:undelete', options)
1757
+ command.request_representation = Google::Apis::ContentV2_1::UndeleteConversionSourceRequest::Representation
1758
+ command.request_object = undelete_conversion_source_request_object
1759
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
1760
+ command.params['conversionSourceId'] = conversion_source_id unless conversion_source_id.nil?
1761
+ command.query['fields'] = fields unless fields.nil?
1762
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1763
+ execute_or_queue_command(command, &block)
1764
+ end
1765
+
1551
1766
  # Retrieves a single CSS domain by ID.
1552
1767
  # @param [Fixnum] css_group_id
1553
1768
  # Required. The ID of the managing account. If this parameter is not the same as
@@ -1723,8 +1938,9 @@ module Google
1723
1938
  end
1724
1939
 
1725
1940
  # Invokes a fetch for the datafeed in your Merchant Center account. If you need
1726
- # to call this method more than once per day, we recommend you use the Products
1727
- # service to update your product data.
1941
+ # to call this method more than once per day, we recommend you use the [Products
1942
+ # service](https://developers.google.com/shopping-content/reference/rest/v2.1/
1943
+ # products) to update your product data.
1728
1944
  # @param [Fixnum] merchant_id
1729
1945
  # The ID of the account that manages the datafeed. This account cannot be a
1730
1946
  # multi-client account.
@@ -1938,15 +2154,20 @@ module Google
1938
2154
  # @param [Fixnum] datafeed_id
1939
2155
  # The ID of the datafeed.
1940
2156
  # @param [String] country
1941
- # The country for which to get the datafeed status. If this parameter is
1942
- # provided then language must also be provided. Note that this parameter is
1943
- # required for feeds targeting multiple countries and languages, since a feed
1944
- # may have a different status for each target.
2157
+ # Deprecated. Use `feedLabel` instead. The country to get the datafeed status
2158
+ # for. If this parameter is provided then `language` must also be provided. Note
2159
+ # that this parameter is required for feeds targeting multiple countries and
2160
+ # languages, since a feed may have a different status for each target.
2161
+ # @param [String] feed_label
2162
+ # The feed label to get the datafeed status for. If this parameter is provided
2163
+ # then `language` must also be provided. Note that this parameter is required
2164
+ # for feeds targeting multiple countries and languages, since a feed may have a
2165
+ # different status for each target.
1945
2166
  # @param [String] language
1946
- # The language for which to get the datafeed status. If this parameter is
1947
- # provided then country must also be provided. Note that this parameter is
1948
- # required for feeds targeting multiple countries and languages, since a feed
1949
- # may have a different status for each target.
2167
+ # The language to get the datafeed status for. If this parameter is provided
2168
+ # then `country` must also be provided. Note that this parameter is required for
2169
+ # feeds targeting multiple countries and languages, since a feed may have a
2170
+ # different status for each target.
1950
2171
  # @param [String] fields
1951
2172
  # Selector specifying which fields to include in a partial response.
1952
2173
  # @param [String] quota_user
@@ -1964,13 +2185,14 @@ module Google
1964
2185
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1965
2186
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1966
2187
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1967
- def get_datafeedstatus(merchant_id, datafeed_id, country: nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
2188
+ def get_datafeedstatus(merchant_id, datafeed_id, country: nil, feed_label: nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
1968
2189
  command = make_simple_command(:get, '{merchantId}/datafeedstatuses/{datafeedId}', options)
1969
2190
  command.response_representation = Google::Apis::ContentV2_1::DatafeedStatus::Representation
1970
2191
  command.response_class = Google::Apis::ContentV2_1::DatafeedStatus
1971
2192
  command.params['merchantId'] = merchant_id unless merchant_id.nil?
1972
2193
  command.params['datafeedId'] = datafeed_id unless datafeed_id.nil?
1973
2194
  command.query['country'] = country unless country.nil?
2195
+ command.query['feedLabel'] = feed_label unless feed_label.nil?
1974
2196
  command.query['language'] = language unless language.nil?
1975
2197
  command.query['fields'] = fields unless fields.nil?
1976
2198
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -2015,6 +2237,9 @@ module Google
2015
2237
  end
2016
2238
 
2017
2239
  # Retrieves the status and review eligibility for the free listing program.
2240
+ # Returns errors and warnings if they require action to resolve, will become
2241
+ # disapprovals, or impact impressions. Use `accountstatuses` to view all issues
2242
+ # for an account.
2018
2243
  # @param [Fixnum] merchant_id
2019
2244
  # Required. The ID of the account.
2020
2245
  # @param [String] fields
@@ -2044,8 +2269,9 @@ module Google
2044
2269
  execute_or_queue_command(command, &block)
2045
2270
  end
2046
2271
 
2047
- # Requests a review for Free Listings program in the provided region. Important:
2048
- # This method is only whitelisted for selected merchants.
2272
+ # Requests a review of free listings in a specific region. This method
2273
+ # deprecated. Use the `MerchantSupportService` to view product and account
2274
+ # issues and request a review.
2049
2275
  # @param [Fixnum] merchant_id
2050
2276
  # Required. The ID of the account.
2051
2277
  # @param [Google::Apis::ContentV2_1::RequestReviewFreeListingsRequest] request_review_free_listings_request_object
@@ -2076,6 +2302,98 @@ module Google
2076
2302
  execute_or_queue_command(command, &block)
2077
2303
  end
2078
2304
 
2305
+ # Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.
2306
+ # @param [Fixnum] merchant_id
2307
+ # Required. The ID of the account.
2308
+ # @param [String] fields
2309
+ # Selector specifying which fields to include in a partial response.
2310
+ # @param [String] quota_user
2311
+ # Available to use for quota purposes for server-side applications. Can be any
2312
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2313
+ # @param [Google::Apis::RequestOptions] options
2314
+ # Request-specific options
2315
+ #
2316
+ # @yield [result, err] Result & error if block supplied
2317
+ # @yieldparam result [NilClass] No result returned for this method
2318
+ # @yieldparam err [StandardError] error object if request failed
2319
+ #
2320
+ # @return [void]
2321
+ #
2322
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2323
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2324
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2325
+ def delete_freelistingsprogram_checkoutsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
2326
+ command = make_simple_command(:delete, '{merchantId}/freelistingsprogram/checkoutsettings', options)
2327
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2328
+ command.query['fields'] = fields unless fields.nil?
2329
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2330
+ execute_or_queue_command(command, &block)
2331
+ end
2332
+
2333
+ # Gets Checkout settings for the given merchant. This includes information about
2334
+ # review state, enrollment state and URL settings.
2335
+ # @param [Fixnum] merchant_id
2336
+ # Required. The ID of the account.
2337
+ # @param [String] fields
2338
+ # Selector specifying which fields to include in a partial response.
2339
+ # @param [String] quota_user
2340
+ # Available to use for quota purposes for server-side applications. Can be any
2341
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2342
+ # @param [Google::Apis::RequestOptions] options
2343
+ # Request-specific options
2344
+ #
2345
+ # @yield [result, err] Result & error if block supplied
2346
+ # @yieldparam result [Google::Apis::ContentV2_1::CheckoutSettings] parsed result object
2347
+ # @yieldparam err [StandardError] error object if request failed
2348
+ #
2349
+ # @return [Google::Apis::ContentV2_1::CheckoutSettings]
2350
+ #
2351
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2352
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2353
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2354
+ def get_freelistingsprogram_checkoutsetting(merchant_id, fields: nil, quota_user: nil, options: nil, &block)
2355
+ command = make_simple_command(:get, '{merchantId}/freelistingsprogram/checkoutsettings', options)
2356
+ command.response_representation = Google::Apis::ContentV2_1::CheckoutSettings::Representation
2357
+ command.response_class = Google::Apis::ContentV2_1::CheckoutSettings
2358
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2359
+ command.query['fields'] = fields unless fields.nil?
2360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2361
+ execute_or_queue_command(command, &block)
2362
+ end
2363
+
2364
+ # Enrolls merchant in `Checkout` program.
2365
+ # @param [Fixnum] merchant_id
2366
+ # Required. The ID of the account.
2367
+ # @param [Google::Apis::ContentV2_1::InsertCheckoutSettingsRequest] insert_checkout_settings_request_object
2368
+ # @param [String] fields
2369
+ # Selector specifying which fields to include in a partial response.
2370
+ # @param [String] quota_user
2371
+ # Available to use for quota purposes for server-side applications. Can be any
2372
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2373
+ # @param [Google::Apis::RequestOptions] options
2374
+ # Request-specific options
2375
+ #
2376
+ # @yield [result, err] Result & error if block supplied
2377
+ # @yieldparam result [Google::Apis::ContentV2_1::CheckoutSettings] parsed result object
2378
+ # @yieldparam err [StandardError] error object if request failed
2379
+ #
2380
+ # @return [Google::Apis::ContentV2_1::CheckoutSettings]
2381
+ #
2382
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2383
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2384
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2385
+ def insert_checkoutsetting_checkout_settings(merchant_id, insert_checkout_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2386
+ command = make_simple_command(:post, '{merchantId}/freelistingsprogram/checkoutsettings', options)
2387
+ command.request_representation = Google::Apis::ContentV2_1::InsertCheckoutSettingsRequest::Representation
2388
+ command.request_object = insert_checkout_settings_request_object
2389
+ command.response_representation = Google::Apis::ContentV2_1::CheckoutSettings::Representation
2390
+ command.response_class = Google::Apis::ContentV2_1::CheckoutSettings
2391
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2392
+ command.query['fields'] = fields unless fields.nil?
2393
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2394
+ execute_or_queue_command(command, &block)
2395
+ end
2396
+
2079
2397
  # Retrieves and/or updates the LIA settings of multiple accounts in a single
2080
2398
  # request.
2081
2399
  # @param [Google::Apis::ContentV2_1::LiasettingsCustomBatchRequest] liasettings_custom_batch_request_object
@@ -2366,6 +2684,59 @@ module Google
2366
2684
  execute_or_queue_command(command, &block)
2367
2685
  end
2368
2686
 
2687
+ # Sets the omnichannel experience for the specified country. Only supported for
2688
+ # merchants whose POS data provider is trusted to enable the corresponding
2689
+ # experience. For more context, see these help articles [about LFP](https://
2690
+ # support.google.com/merchants/answer/7676652) and [how to get started](https://
2691
+ # support.google.com/merchants/answer/7676578) with it.
2692
+ # @param [Fixnum] merchant_id
2693
+ # The ID of the managing account. If this parameter is not the same as accountId,
2694
+ # then this account must be a multi-client account and `accountId` must be the
2695
+ # ID of a sub-account of this account.
2696
+ # @param [Fixnum] account_id
2697
+ # The ID of the account for which to retrieve accessible Business Profiles.
2698
+ # @param [String] country
2699
+ # The CLDR country code (for example, "US") for which the omnichannel experience
2700
+ # is selected.
2701
+ # @param [String] lsf_type
2702
+ # The Local Store Front (LSF) type for this country. Acceptable values are: - "`
2703
+ # ghlsf`" (Google-Hosted Local Store Front) - "`mhlsfBasic`" (Merchant-Hosted
2704
+ # Local Store Front Basic) - "`mhlsfFull`" (Merchant-Hosted Local Store Front
2705
+ # Full) More details about these types can be found here.
2706
+ # @param [Array<String>, String] pickup_types
2707
+ # The Pickup types for this country. Acceptable values are: - "`pickupToday`" - "
2708
+ # `pickupLater`"
2709
+ # @param [String] fields
2710
+ # Selector specifying which fields to include in a partial response.
2711
+ # @param [String] quota_user
2712
+ # Available to use for quota purposes for server-side applications. Can be any
2713
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2714
+ # @param [Google::Apis::RequestOptions] options
2715
+ # Request-specific options
2716
+ #
2717
+ # @yield [result, err] Result & error if block supplied
2718
+ # @yieldparam result [Google::Apis::ContentV2_1::LiaOmnichannelExperience] parsed result object
2719
+ # @yieldparam err [StandardError] error object if request failed
2720
+ #
2721
+ # @return [Google::Apis::ContentV2_1::LiaOmnichannelExperience]
2722
+ #
2723
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2724
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2725
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2726
+ def setomnichannelexperience_liasetting(merchant_id, account_id, country: nil, lsf_type: nil, pickup_types: nil, fields: nil, quota_user: nil, options: nil, &block)
2727
+ command = make_simple_command(:post, '{merchantId}/liasettings/{accountId}/setomnichannelexperience', options)
2728
+ command.response_representation = Google::Apis::ContentV2_1::LiaOmnichannelExperience::Representation
2729
+ command.response_class = Google::Apis::ContentV2_1::LiaOmnichannelExperience
2730
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2731
+ command.params['accountId'] = account_id unless account_id.nil?
2732
+ command.query['country'] = country unless country.nil?
2733
+ command.query['lsfType'] = lsf_type unless lsf_type.nil?
2734
+ command.query['pickupTypes'] = pickup_types unless pickup_types.nil?
2735
+ command.query['fields'] = fields unless fields.nil?
2736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2737
+ execute_or_queue_command(command, &block)
2738
+ end
2739
+
2369
2740
  # Sets the POS data provider for the specified country.
2370
2741
  # @param [Fixnum] merchant_id
2371
2742
  # The ID of the managing account. If this parameter is not the same as accountId,
@@ -2516,6 +2887,101 @@ module Google
2516
2887
  execute_or_queue_command(command, &block)
2517
2888
  end
2518
2889
 
2890
+ # Provide a list of merchant's issues with a support content and available
2891
+ # actions. This content and actions are meant to be rendered and shown in third-
2892
+ # party applications.
2893
+ # @param [Fixnum] merchant_id
2894
+ # Required. The ID of the account to fetch issues for.
2895
+ # @param [Google::Apis::ContentV2_1::RenderAccountIssuesRequestPayload] render_account_issues_request_payload_object
2896
+ # @param [String] language_code
2897
+ # Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code
2898
+ # used to localize support content. If not set, the result will be in default
2899
+ # language ('en-US').
2900
+ # @param [String] time_zone
2901
+ # Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
2902
+ # localize times in support content. For example 'America/Los_Angeles'. If not
2903
+ # set, results will use as a default UTC.
2904
+ # @param [String] fields
2905
+ # Selector specifying which fields to include in a partial response.
2906
+ # @param [String] quota_user
2907
+ # Available to use for quota purposes for server-side applications. Can be any
2908
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2909
+ # @param [Google::Apis::RequestOptions] options
2910
+ # Request-specific options
2911
+ #
2912
+ # @yield [result, err] Result & error if block supplied
2913
+ # @yieldparam result [Google::Apis::ContentV2_1::RenderAccountIssuesResponse] parsed result object
2914
+ # @yieldparam err [StandardError] error object if request failed
2915
+ #
2916
+ # @return [Google::Apis::ContentV2_1::RenderAccountIssuesResponse]
2917
+ #
2918
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2919
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2920
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2921
+ def renderaccountissues_merchantsupport(merchant_id, render_account_issues_request_payload_object = nil, language_code: nil, time_zone: nil, fields: nil, quota_user: nil, options: nil, &block)
2922
+ command = make_simple_command(:post, '{merchantId}/merchantsupport/renderaccountissues', options)
2923
+ command.request_representation = Google::Apis::ContentV2_1::RenderAccountIssuesRequestPayload::Representation
2924
+ command.request_object = render_account_issues_request_payload_object
2925
+ command.response_representation = Google::Apis::ContentV2_1::RenderAccountIssuesResponse::Representation
2926
+ command.response_class = Google::Apis::ContentV2_1::RenderAccountIssuesResponse
2927
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2928
+ command.query['languageCode'] = language_code unless language_code.nil?
2929
+ command.query['timeZone'] = time_zone unless time_zone.nil?
2930
+ command.query['fields'] = fields unless fields.nil?
2931
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2932
+ execute_or_queue_command(command, &block)
2933
+ end
2934
+
2935
+ # Provide a list of issues for merchant's product with a support content and
2936
+ # available actions. This content and actions are meant to be rendered and shown
2937
+ # in third-party applications.
2938
+ # @param [Fixnum] merchant_id
2939
+ # Required. The ID of the account that contains the product.
2940
+ # @param [String] product_id
2941
+ # Required. The [REST_ID](https://developers.google.com/shopping-content/
2942
+ # reference/rest/v2.1/products#Product.FIELDS.id) of the product to fetch issues
2943
+ # for.
2944
+ # @param [Google::Apis::ContentV2_1::RenderProductIssuesRequestPayload] render_product_issues_request_payload_object
2945
+ # @param [String] language_code
2946
+ # Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code
2947
+ # used to localize support content. If not set, the result will be in default
2948
+ # language ('en-US').
2949
+ # @param [String] time_zone
2950
+ # Optional. The [IANA](https://www.iana.org/time-zones) timezone used to
2951
+ # localize times in support content. For example 'America/Los_Angeles'. If not
2952
+ # set, results will use as a default UTC.
2953
+ # @param [String] fields
2954
+ # Selector specifying which fields to include in a partial response.
2955
+ # @param [String] quota_user
2956
+ # Available to use for quota purposes for server-side applications. Can be any
2957
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2958
+ # @param [Google::Apis::RequestOptions] options
2959
+ # Request-specific options
2960
+ #
2961
+ # @yield [result, err] Result & error if block supplied
2962
+ # @yieldparam result [Google::Apis::ContentV2_1::RenderProductIssuesResponse] parsed result object
2963
+ # @yieldparam err [StandardError] error object if request failed
2964
+ #
2965
+ # @return [Google::Apis::ContentV2_1::RenderProductIssuesResponse]
2966
+ #
2967
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2968
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2969
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2970
+ def renderproductissues_merchantsupport(merchant_id, product_id, render_product_issues_request_payload_object = nil, language_code: nil, time_zone: nil, fields: nil, quota_user: nil, options: nil, &block)
2971
+ command = make_simple_command(:post, '{merchantId}/merchantsupport/renderproductissues/{productId}', options)
2972
+ command.request_representation = Google::Apis::ContentV2_1::RenderProductIssuesRequestPayload::Representation
2973
+ command.request_object = render_product_issues_request_payload_object
2974
+ command.response_representation = Google::Apis::ContentV2_1::RenderProductIssuesResponse::Representation
2975
+ command.response_class = Google::Apis::ContentV2_1::RenderProductIssuesResponse
2976
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
2977
+ command.params['productId'] = product_id unless product_id.nil?
2978
+ command.query['languageCode'] = language_code unless language_code.nil?
2979
+ command.query['timeZone'] = time_zone unless time_zone.nil?
2980
+ command.query['fields'] = fields unless fields.nil?
2981
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2982
+ execute_or_queue_command(command, &block)
2983
+ end
2984
+
2519
2985
  # Creates a charge invoice for a shipment group, and triggers a charge capture
2520
2986
  # for orderinvoice enabled orders.
2521
2987
  # @param [Fixnum] merchant_id
@@ -3335,7 +3801,7 @@ module Google
3335
3801
  # @param [String] template_name
3336
3802
  # The name of the template to retrieve.
3337
3803
  # @param [String] country
3338
- # The country of the template to retrieve. Defaults to `US`.
3804
+ # The country of the template to retrieve. Defaults to "`US`".
3339
3805
  # @param [String] fields
3340
3806
  # Selector specifying which fields to include in a partial response.
3341
3807
  # @param [String] quota_user
@@ -3366,13 +3832,13 @@ module Google
3366
3832
  end
3367
3833
 
3368
3834
  # Deprecated. Notifies that item return and refund was handled directly by
3369
- # merchant outside of Google payments processing (e.g. cash refund done in store)
3370
- # . Note: We recommend calling the returnrefundlineitem method to refund in-
3371
- # store returns. We will issue the refund directly to the customer. This helps
3372
- # to prevent possible differences arising between merchant and Google
3835
+ # merchant outside of Google payments processing (for example, cash refund done
3836
+ # in store). Note: We recommend calling the returnrefundlineitem method to
3837
+ # refund in-store returns. We will issue the refund directly to the customer.
3838
+ # This helps to prevent possible differences arising between merchant and Google
3373
3839
  # transaction records. We also recommend having the point of sale system
3374
3840
  # communicate with Google to ensure that customers do not receive a double
3375
- # refund by first refunding via Google then via an in-store return.
3841
+ # refund by first refunding through Google then through an in-store return.
3376
3842
  # @param [Fixnum] merchant_id
3377
3843
  # The ID of the account that manages the order. This cannot be a multi-client
3378
3844
  # account.
@@ -3433,10 +3899,10 @@ module Google
3433
3899
  # @param [String] placed_date_start
3434
3900
  # Obtains orders placed after this date (inclusively), in ISO 8601 format.
3435
3901
  # @param [Array<String>, String] statuses
3436
- # Obtains orders that match any of the specified statuses. Please note that `
3437
- # active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `
3438
- # completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `
3439
- # partiallyReturned`, `returned`, and `canceled`.
3902
+ # Obtains orders that match any of the specified statuses. Note that `active` is
3903
+ # a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a
3904
+ # shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`,
3905
+ # `returned`, and `canceled`.
3440
3906
  # @param [String] fields
3441
3907
  # Selector specifying which fields to include in a partial response.
3442
3908
  # @param [String] quota_user
@@ -3583,11 +4049,11 @@ module Google
3583
4049
  end
3584
4050
 
3585
4051
  # Returns and refunds a line item. Note that this method can only be called on
3586
- # fully shipped orders. Please also note that the Orderreturns API is the
3587
- # preferred way to handle returns after you receive a return from a customer.
3588
- # You can use Orderreturns.list or Orderreturns.get to search for the return,
3589
- # and then use Orderreturns.processreturn to issue the refund. If the return
3590
- # cannot be found, then we recommend using this API to issue a refund.
4052
+ # fully shipped orders. The Orderreturns API is the preferred way to handle
4053
+ # returns after you receive a return from a customer. You can use Orderreturns.
4054
+ # list or Orderreturns.get to search for the return, and then use Orderreturns.
4055
+ # processreturn to issue the refund. If the return cannot be found, then we
4056
+ # recommend using this API to issue a refund.
3591
4057
  # @param [Fixnum] merchant_id
3592
4058
  # The ID of the account that manages the order. This cannot be a multi-client
3593
4059
  # account.
@@ -3627,8 +4093,8 @@ module Google
3627
4093
  # Sets (or overrides if it already exists) merchant provided annotations in the
3628
4094
  # form of key-value pairs. A common use case would be to supply us with
3629
4095
  # additional structured information about a line item that cannot be provided
3630
- # via other methods. Submitted key-value pairs can be retrieved as part of the
3631
- # orders resource.
4096
+ # through other methods. Submitted key-value pairs can be retrieved as part of
4097
+ # the orders resource.
3632
4098
  # @param [Fixnum] merchant_id
3633
4099
  # The ID of the account that manages the order. This cannot be a multi-client
3634
4100
  # account.
@@ -4087,6 +4553,108 @@ module Google
4087
4553
  execute_or_queue_command(command, &block)
4088
4554
  end
4089
4555
 
4556
+ # Creates or updates the delivery time of a product.
4557
+ # @param [Fixnum] merchant_id
4558
+ # The Google merchant ID of the account that contains the product. This account
4559
+ # cannot be a multi-client account.
4560
+ # @param [Google::Apis::ContentV2_1::ProductDeliveryTime] product_delivery_time_object
4561
+ # @param [String] fields
4562
+ # Selector specifying which fields to include in a partial response.
4563
+ # @param [String] quota_user
4564
+ # Available to use for quota purposes for server-side applications. Can be any
4565
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4566
+ # @param [Google::Apis::RequestOptions] options
4567
+ # Request-specific options
4568
+ #
4569
+ # @yield [result, err] Result & error if block supplied
4570
+ # @yieldparam result [Google::Apis::ContentV2_1::ProductDeliveryTime] parsed result object
4571
+ # @yieldparam err [StandardError] error object if request failed
4572
+ #
4573
+ # @return [Google::Apis::ContentV2_1::ProductDeliveryTime]
4574
+ #
4575
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4576
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4577
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4578
+ def create_productdeliverytime(merchant_id, product_delivery_time_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4579
+ command = make_simple_command(:post, '{merchantId}/productdeliverytime', options)
4580
+ command.request_representation = Google::Apis::ContentV2_1::ProductDeliveryTime::Representation
4581
+ command.request_object = product_delivery_time_object
4582
+ command.response_representation = Google::Apis::ContentV2_1::ProductDeliveryTime::Representation
4583
+ command.response_class = Google::Apis::ContentV2_1::ProductDeliveryTime
4584
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
4585
+ command.query['fields'] = fields unless fields.nil?
4586
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4587
+ execute_or_queue_command(command, &block)
4588
+ end
4589
+
4590
+ # Deletes the delivery time of a product.
4591
+ # @param [Fixnum] merchant_id
4592
+ # Required. The Google merchant ID of the account that contains the product.
4593
+ # This account cannot be a multi-client account.
4594
+ # @param [String] product_id
4595
+ # Required. The Content API ID of the product, in the form `channel:
4596
+ # contentLanguage:targetCountry:offerId`.
4597
+ # @param [String] fields
4598
+ # Selector specifying which fields to include in a partial response.
4599
+ # @param [String] quota_user
4600
+ # Available to use for quota purposes for server-side applications. Can be any
4601
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4602
+ # @param [Google::Apis::RequestOptions] options
4603
+ # Request-specific options
4604
+ #
4605
+ # @yield [result, err] Result & error if block supplied
4606
+ # @yieldparam result [NilClass] No result returned for this method
4607
+ # @yieldparam err [StandardError] error object if request failed
4608
+ #
4609
+ # @return [void]
4610
+ #
4611
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4612
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4613
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4614
+ def delete_productdeliverytime(merchant_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
4615
+ command = make_simple_command(:delete, '{merchantId}/productdeliverytime/{productId}', options)
4616
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
4617
+ command.params['productId'] = product_id unless product_id.nil?
4618
+ command.query['fields'] = fields unless fields.nil?
4619
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4620
+ execute_or_queue_command(command, &block)
4621
+ end
4622
+
4623
+ # Gets `productDeliveryTime` by `productId`.
4624
+ # @param [Fixnum] merchant_id
4625
+ # Required. The Google merchant ID of the account that contains the product.
4626
+ # This account cannot be a multi-client account.
4627
+ # @param [String] product_id
4628
+ # Required. The Content API ID of the product, in the form `channel:
4629
+ # contentLanguage:targetCountry:offerId`.
4630
+ # @param [String] fields
4631
+ # Selector specifying which fields to include in a partial response.
4632
+ # @param [String] quota_user
4633
+ # Available to use for quota purposes for server-side applications. Can be any
4634
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4635
+ # @param [Google::Apis::RequestOptions] options
4636
+ # Request-specific options
4637
+ #
4638
+ # @yield [result, err] Result & error if block supplied
4639
+ # @yieldparam result [Google::Apis::ContentV2_1::ProductDeliveryTime] parsed result object
4640
+ # @yieldparam err [StandardError] error object if request failed
4641
+ #
4642
+ # @return [Google::Apis::ContentV2_1::ProductDeliveryTime]
4643
+ #
4644
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4645
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4646
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4647
+ def get_productdeliverytime(merchant_id, product_id, fields: nil, quota_user: nil, options: nil, &block)
4648
+ command = make_simple_command(:get, '{merchantId}/productdeliverytime/{productId}', options)
4649
+ command.response_representation = Google::Apis::ContentV2_1::ProductDeliveryTime::Representation
4650
+ command.response_class = Google::Apis::ContentV2_1::ProductDeliveryTime
4651
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
4652
+ command.params['productId'] = product_id unless product_id.nil?
4653
+ command.query['fields'] = fields unless fields.nil?
4654
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4655
+ execute_or_queue_command(command, &block)
4656
+ end
4657
+
4090
4658
  # Retrieves, inserts, and deletes multiple products in a single request.
4091
4659
  # @param [Google::Apis::ContentV2_1::ProductsCustomBatchRequest] products_custom_batch_request_object
4092
4660
  # @param [String] fields
@@ -4234,7 +4802,8 @@ module Google
4234
4802
  # The ID of the account that contains the products. This account cannot be a
4235
4803
  # multi-client account.
4236
4804
  # @param [Fixnum] max_results
4237
- # The maximum number of products to return in the response, used for paging.
4805
+ # The maximum number of products to return in the response, used for paging. The
4806
+ # default value is 25. The maximum value is 250.
4238
4807
  # @param [String] page_token
4239
4808
  # The token returned by the previous request.
4240
4809
  # @param [String] fields
@@ -4277,9 +4846,10 @@ module Google
4277
4846
  # @param [String] update_mask
4278
4847
  # The comma-separated list of product attributes to be updated. Example: `"title,
4279
4848
  # salePrice"`. Attributes specified in the update mask without a value specified
4280
- # in the body will be deleted from the product. Only top-level product
4281
- # attributes can be updated. If not defined, product attributes with set values
4282
- # will be updated and other attributes will stay unchanged.
4849
+ # in the body will be deleted from the product. *You must specify the update
4850
+ # mask to delete attributes.* Only top-level product attributes can be updated.
4851
+ # If not defined, product attributes with set values will be updated and other
4852
+ # attributes will stay unchanged.
4283
4853
  # @param [String] fields
4284
4854
  # Selector specifying which fields to include in a partial response.
4285
4855
  # @param [String] quota_user
@@ -4388,7 +4958,7 @@ module Google
4388
4958
  # only issues for the Shopping destination.
4389
4959
  # @param [Fixnum] max_results
4390
4960
  # The maximum number of product statuses to return in the response, used for
4391
- # paging.
4961
+ # paging. The default value is 25. The maximum value is 250.
4392
4962
  # @param [String] page_token
4393
4963
  # The token returned by the previous request.
4394
4964
  # @param [String] fields
@@ -4483,7 +5053,10 @@ module Google
4483
5053
  end
4484
5054
 
4485
5055
  # Inserts a promotion for your Merchant Center account. If the promotion already
4486
- # exists, then it will update the promotion instead.
5056
+ # exists, then it updates the promotion instead. To [end or delete] (https://
5057
+ # developers.google.com/shopping-content/guides/promotions#end_a_promotion) a
5058
+ # promotion update the time period of the promotion to a time that has already
5059
+ # passed.
4487
5060
  # @param [Fixnum] merchant_id
4488
5061
  # Required. The ID of the account that contains the collection.
4489
5062
  # @param [Google::Apis::ContentV2_1::Promotion] promotion_object
@@ -4549,6 +5122,54 @@ module Google
4549
5122
  execute_or_queue_command(command, &block)
4550
5123
  end
4551
5124
 
5125
+ # List all promotions from your Merchant Center account.
5126
+ # @param [Fixnum] merchant_id
5127
+ # Required. The ID of the account that contains the collection.
5128
+ # @param [String] country_code
5129
+ # [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/
5130
+ # en.xml) (for example, "US"), used as a filter on promotions target country.
5131
+ # @param [String] language_code
5132
+ # The two-letter ISO 639-1 language code associated with the promotions, used as
5133
+ # a filter.
5134
+ # @param [Fixnum] page_size
5135
+ # The maximum number of promotions to return. The service may return fewer than
5136
+ # this value. If unspecified, at most 50 labels will be returned. The maximum
5137
+ # value is 1000; values above 1000 will be coerced to 1000.
5138
+ # @param [String] page_token
5139
+ # A page token, received from a previous `ListPromotion` call. Provide this to
5140
+ # retrieve the subsequent page. When paginating, all other parameters provided
5141
+ # to `ListPromotion` must match the call that provided the page token.
5142
+ # @param [String] fields
5143
+ # Selector specifying which fields to include in a partial response.
5144
+ # @param [String] quota_user
5145
+ # Available to use for quota purposes for server-side applications. Can be any
5146
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5147
+ # @param [Google::Apis::RequestOptions] options
5148
+ # Request-specific options
5149
+ #
5150
+ # @yield [result, err] Result & error if block supplied
5151
+ # @yieldparam result [Google::Apis::ContentV2_1::ListPromotionResponse] parsed result object
5152
+ # @yieldparam err [StandardError] error object if request failed
5153
+ #
5154
+ # @return [Google::Apis::ContentV2_1::ListPromotionResponse]
5155
+ #
5156
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5157
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5158
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5159
+ def list_promotions(merchant_id, country_code: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5160
+ command = make_simple_command(:get, '{merchantId}/promotions', options)
5161
+ command.response_representation = Google::Apis::ContentV2_1::ListPromotionResponse::Representation
5162
+ command.response_class = Google::Apis::ContentV2_1::ListPromotionResponse
5163
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
5164
+ command.query['countryCode'] = country_code unless country_code.nil?
5165
+ command.query['languageCode'] = language_code unless language_code.nil?
5166
+ command.query['pageSize'] = page_size unless page_size.nil?
5167
+ command.query['pageToken'] = page_token unless page_token.nil?
5168
+ command.query['fields'] = fields unless fields.nil?
5169
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5170
+ execute_or_queue_command(command, &block)
5171
+ end
5172
+
4552
5173
  # Retrieves a Merchant Center account's pubsub notification settings.
4553
5174
  # @param [Fixnum] merchant_id
4554
5175
  # The ID of the account for which to get pubsub notification settings.
@@ -4580,7 +5201,7 @@ module Google
4580
5201
  end
4581
5202
 
4582
5203
  # Register a Merchant Center account for pubsub notifications. Note that cloud
4583
- # topic name should not be provided as part of the request.
5204
+ # topic name shouldn't be provided as part of the request.
4584
5205
  # @param [Fixnum] merchant_id
4585
5206
  # The ID of the account.
4586
5207
  # @param [Google::Apis::ContentV2_1::PubsubNotificationSettings] pubsub_notification_settings_object
@@ -4613,6 +5234,119 @@ module Google
4613
5234
  execute_or_queue_command(command, &block)
4614
5235
  end
4615
5236
 
5237
+ # Lists the daily call quota and usage per method for your Merchant Center
5238
+ # account.
5239
+ # @param [Fixnum] merchant_id
5240
+ # Required. The ID of the account that has quota. This account must be an admin.
5241
+ # @param [Fixnum] page_size
5242
+ # The maximum number of quotas to return in the response, used for paging.
5243
+ # Defaults to 500; values above 1000 will be coerced to 1000.
5244
+ # @param [String] page_token
5245
+ # Token (if provided) to retrieve the subsequent page. All other parameters must
5246
+ # match the original call that provided the page token.
5247
+ # @param [String] fields
5248
+ # Selector specifying which fields to include in a partial response.
5249
+ # @param [String] quota_user
5250
+ # Available to use for quota purposes for server-side applications. Can be any
5251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5252
+ # @param [Google::Apis::RequestOptions] options
5253
+ # Request-specific options
5254
+ #
5255
+ # @yield [result, err] Result & error if block supplied
5256
+ # @yieldparam result [Google::Apis::ContentV2_1::ListMethodQuotasResponse] parsed result object
5257
+ # @yieldparam err [StandardError] error object if request failed
5258
+ #
5259
+ # @return [Google::Apis::ContentV2_1::ListMethodQuotasResponse]
5260
+ #
5261
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5262
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5263
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5264
+ def list_quotas(merchant_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
5265
+ command = make_simple_command(:get, '{merchantId}/quotas', options)
5266
+ command.response_representation = Google::Apis::ContentV2_1::ListMethodQuotasResponse::Representation
5267
+ command.response_class = Google::Apis::ContentV2_1::ListMethodQuotasResponse
5268
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
5269
+ command.query['pageSize'] = page_size unless page_size.nil?
5270
+ command.query['pageToken'] = page_token unless page_token.nil?
5271
+ command.query['fields'] = fields unless fields.nil?
5272
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5273
+ execute_or_queue_command(command, &block)
5274
+ end
5275
+
5276
+ # Generates recommendations for a merchant.
5277
+ # @param [Fixnum] merchant_id
5278
+ # Required. The ID of the account to fetch recommendations for.
5279
+ # @param [Array<String>, String] allowed_tag
5280
+ # Optional. List of allowed tags. Tags are a set of predefined strings that
5281
+ # describe the category that individual recommendation types belong to. User can
5282
+ # specify zero or more tags in this field to indicate what categories of
5283
+ # recommendations they want to receive. Current list of supported tags: - TREND
5284
+ # @param [String] language_code
5285
+ # Optional. Language code of the client. If not set, the result will be in
5286
+ # default language (English). This language code affects all fields prefixed
5287
+ # with "localized". This should be set to ISO 639-1 country code. List of
5288
+ # currently verified supported language code: en, fr, cs, da, de, es, it, nl, no,
5289
+ # pl, pt, pt, fi, sv, vi, tr, th, ko, zh-CN, zh-TW, ja, id, hi
5290
+ # @param [String] fields
5291
+ # Selector specifying which fields to include in a partial response.
5292
+ # @param [String] quota_user
5293
+ # Available to use for quota purposes for server-side applications. Can be any
5294
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5295
+ # @param [Google::Apis::RequestOptions] options
5296
+ # Request-specific options
5297
+ #
5298
+ # @yield [result, err] Result & error if block supplied
5299
+ # @yieldparam result [Google::Apis::ContentV2_1::GenerateRecommendationsResponse] parsed result object
5300
+ # @yieldparam err [StandardError] error object if request failed
5301
+ #
5302
+ # @return [Google::Apis::ContentV2_1::GenerateRecommendationsResponse]
5303
+ #
5304
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5305
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5306
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5307
+ def generate_recommendation(merchant_id, allowed_tag: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
5308
+ command = make_simple_command(:get, '{merchantId}/recommendations/generate', options)
5309
+ command.response_representation = Google::Apis::ContentV2_1::GenerateRecommendationsResponse::Representation
5310
+ command.response_class = Google::Apis::ContentV2_1::GenerateRecommendationsResponse
5311
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
5312
+ command.query['allowedTag'] = allowed_tag unless allowed_tag.nil?
5313
+ command.query['languageCode'] = language_code unless language_code.nil?
5314
+ command.query['fields'] = fields unless fields.nil?
5315
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5316
+ execute_or_queue_command(command, &block)
5317
+ end
5318
+
5319
+ # Reports an interaction on a recommendation for a merchant.
5320
+ # @param [Fixnum] merchant_id
5321
+ # Required. The ID of the account that wants to report an interaction.
5322
+ # @param [Google::Apis::ContentV2_1::ReportInteractionRequest] report_interaction_request_object
5323
+ # @param [String] fields
5324
+ # Selector specifying which fields to include in a partial response.
5325
+ # @param [String] quota_user
5326
+ # Available to use for quota purposes for server-side applications. Can be any
5327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5328
+ # @param [Google::Apis::RequestOptions] options
5329
+ # Request-specific options
5330
+ #
5331
+ # @yield [result, err] Result & error if block supplied
5332
+ # @yieldparam result [NilClass] No result returned for this method
5333
+ # @yieldparam err [StandardError] error object if request failed
5334
+ #
5335
+ # @return [void]
5336
+ #
5337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5340
+ def report_recommendation_interaction(merchant_id, report_interaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5341
+ command = make_simple_command(:post, '{merchantId}/recommendations/reportInteraction', options)
5342
+ command.request_representation = Google::Apis::ContentV2_1::ReportInteractionRequest::Representation
5343
+ command.request_object = report_interaction_request_object
5344
+ command.params['merchantId'] = merchant_id unless merchant_id.nil?
5345
+ command.query['fields'] = fields unless fields.nil?
5346
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5347
+ execute_or_queue_command(command, &block)
5348
+ end
5349
+
4616
5350
  # Updates regional inventory for multiple products or regions in a single
4617
5351
  # request.
4618
5352
  # @param [Google::Apis::ContentV2_1::RegionalinventoryCustomBatchRequest] regionalinventory_custom_batch_request_object
@@ -4644,8 +5378,8 @@ module Google
4644
5378
  execute_or_queue_command(command, &block)
4645
5379
  end
4646
5380
 
4647
- # Update the regional inventory of a product in your Merchant Center account. If
4648
- # a regional inventory with the same region ID already exists, this method
5381
+ # Updates the regional inventory of a product in your Merchant Center account.
5382
+ # If a regional inventory with the same region ID already exists, this method
4649
5383
  # updates that entry.
4650
5384
  # @param [Fixnum] merchant_id
4651
5385
  # The ID of the account that contains the product. This account cannot be a
@@ -5003,7 +5737,7 @@ module Google
5003
5737
  # Required. The id of the merchant who owns the repricing rule.
5004
5738
  # @param [String] country_code
5005
5739
  # [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/
5006
- # en.xml) (e.g. "US"), used as a filter on repricing rules.
5740
+ # en.xml) (for example, "US"), used as a filter on repricing rules.
5007
5741
  # @param [String] language_code
5008
5742
  # The two-letter ISO 639-1 language code associated with the repricing rule,
5009
5743
  # used as a filter.
@@ -5087,7 +5821,8 @@ module Google
5087
5821
  execute_or_queue_command(command, &block)
5088
5822
  end
5089
5823
 
5090
- # Lists the metrics report for a given Repricing rule.
5824
+ # *Deprecated*: New merchants can't start using this service. Lists the metrics
5825
+ # report for a given Repricing rule.
5091
5826
  # @param [Fixnum] merchant_id
5092
5827
  # Required. Id of the merchant who owns the Repricing rule.
5093
5828
  # @param [String] rule_id
@@ -5990,6 +6725,9 @@ module Google
5990
6725
  end
5991
6726
 
5992
6727
  # Retrieves the status and review eligibility for the Shopping Ads program.
6728
+ # Returns errors and warnings if they require action to resolve, will become
6729
+ # disapprovals, or impact impressions. Use `accountstatuses` to view all issues
6730
+ # for an account.
5993
6731
  # @param [Fixnum] merchant_id
5994
6732
  # Required. The ID of the account.
5995
6733
  # @param [String] fields
@@ -6019,7 +6757,9 @@ module Google
6019
6757
  execute_or_queue_command(command, &block)
6020
6758
  end
6021
6759
 
6022
- # Requests a review for Shopping Ads program in the provided country.
6760
+ # Requests a review of Shopping ads in a specific region. This method deprecated.
6761
+ # Use the `MerchantSupportService` to view product and account issues and
6762
+ # request a review.
6023
6763
  # @param [Fixnum] merchant_id
6024
6764
  # Required. The ID of the account.
6025
6765
  # @param [Google::Apis::ContentV2_1::RequestReviewShoppingAdsRequest] request_review_shopping_ads_request_object