google-apis-retail_v2alpha 0.37.0 → 0.38.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: caea85e4dc8a3c22833aa7302515b8e21035a770cc0be655122536284b33c4ba
4
- data.tar.gz: 2a40905b2e51af4d99ceff5d672ba74d77e84752427ae54c7419ba4f8c4fb5bd
3
+ metadata.gz: ba10e95f3d815683efb03c3323757ae9d7dc0269f79538bafbd756f94860ad5a
4
+ data.tar.gz: 6c74625a3f65698985a51145dd3e3d67acf93964cd37549b266abb443b791f6b
5
5
  SHA512:
6
- metadata.gz: 5093e1e3bbd1f1666e27b98e9790922611226c3e668e287aa7fad5397db44c692c85dbe42857db9f848173083dc46c48fd9b1c1429f82a04aa65a2e2faa4582e
7
- data.tar.gz: 20a3171589e843b72530a88b00881c15bc0093f37a9b0ab6ee6bb02f5d1f179f57c76998a319167481951b646d1e541fab513956bc8878def75749abade94a9f
6
+ metadata.gz: '04878e1823e9576c8a5ea36b9de1fbb577b68e8137a4a23deeed3548c0d6f55e00f3e8d418de2e27c23560927422b08625e756c98c0d96c61f2b82b51c7a0c96'
7
+ data.tar.gz: '09aa565835ca273ab0058290cb62a688cc058c2117d71dd053be92283ccfb848d98877277e1e3671e4ab043ac0b6621a9958c4df61b06c7fad3fdda44bdda3d1'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.38.0 (2022-04-28)
4
+
5
+ * Regenerated from discovery document revision 20220421
6
+
3
7
  ### v0.37.0 (2022-04-22)
4
8
 
5
9
  * Regenerated from discovery document revision 20220414
@@ -1567,12 +1567,13 @@ module Google
1567
1567
  class GoogleCloudRetailV2alphaCustomAttribute
1568
1568
  include Google::Apis::Core::Hashable
1569
1569
 
1570
- # This field will only be used when AttributesConfig.attribute_config_level of
1571
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
1572
- # values are indexed, so that it can be filtered, faceted or boosted in
1573
- # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
1574
- # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
1575
- # details.
1570
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
1571
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
1572
+ # You may learn more on [configuration mode] (https://cloud.google.com/retail/
1573
+ # docs/attribute-config#config-modes). if true, custom attribute values are
1574
+ # indexed, so that it can be filtered, faceted or boosted in SearchService.
1575
+ # Search. This field is ignored in a UserEvent. See SearchRequest.filter,
1576
+ # SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
1576
1577
  # Corresponds to the JSON property `indexable`
1577
1578
  # @return [Boolean]
1578
1579
  attr_accessor :indexable
@@ -1585,11 +1586,13 @@ module Google
1585
1586
  # @return [Array<Float>]
1586
1587
  attr_accessor :numbers
1587
1588
 
1588
- # This field will only be used when AttributesConfig.attribute_config_level of
1589
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
1590
- # values are searchable by text queries in SearchService.Search. This field is
1591
- # ignored in a UserEvent. Only set if type text is set. Otherwise, a
1592
- # INVALID_ARGUMENT error is returned.
1589
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
1590
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
1591
+ # You may learn more on [configuration mode] (https://cloud.google.com/retail/
1592
+ # docs/attribute-config#config-modes). If true, custom attribute values are
1593
+ # searchable by text queries in SearchService.Search. This field is ignored in a
1594
+ # UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error
1595
+ # is returned.
1593
1596
  # Corresponds to the JSON property `searchable`
1594
1597
  # @return [Boolean]
1595
1598
  attr_accessor :searchable
@@ -4609,7 +4612,9 @@ module Google
4609
4612
  # @return [String]
4610
4613
  attr_accessor :attribution_token
4611
4614
 
4612
- # If spell correction applies, the corrected query. Otherwise, empty.
4615
+ # Contains the spell corrected query, if found. If the spell correction type is
4616
+ # AUTOMATIC, then the search results will be based on corrected_query, otherwise
4617
+ # the original query will be used for search.
4613
4618
  # Corresponds to the JSON property `correctedQuery`
4614
4619
  # @return [String]
4615
4620
  attr_accessor :corrected_query
@@ -5247,9 +5252,9 @@ module Google
5247
5252
  # @return [String]
5248
5253
  attr_accessor :page_view_id
5249
5254
 
5250
- # The main product details related to the event. This field is required for the
5251
- # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
5252
- # complete` * `search` In a `search` event, this field represents the products
5255
+ # The main product details related to the event. This field is optional except
5256
+ # for the following event types: * `add-to-cart` * `detail-page-view` * `
5257
+ # purchase-complete` In a `search` event, this field represents the products
5253
5258
  # returned to the end user on the current page (the end user may have not
5254
5259
  # finished browsing the whole page yet). When a new page is returned to the end
5255
5260
  # user, after pagination/filtering/ordering even for the same query, a new `
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.37.0"
19
+ GEM_VERSION = "0.38.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220414"
25
+ REVISION = "20220421"
26
26
  end
27
27
  end
28
28
  end
@@ -1419,15 +1419,12 @@ module Google
1419
1419
  # Makes a recommendation prediction.
1420
1420
  # @param [String] placement
1421
1421
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1422
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1423
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1424
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1425
- # Recommendations AI serving config or placement. Before you can request
1426
- # predictions from your model, you must create at least one serving config or
1427
- # placement for it. For more information, see [Managing serving configurations] (
1428
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1429
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1430
- # retail/catalogs/default_catalog/configs
1422
+ # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1423
+ # placement. Before you can request predictions from your model, you must create
1424
+ # at least one placement for it. For more information, see [Managing placements](
1425
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1426
+ # The full list of available placements can be seen at https://console.cloud.
1427
+ # google.com/recommendation/catalogs/default_catalog/placements
1431
1428
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1432
1429
  # @param [String] fields
1433
1430
  # Selector specifying which fields to include in a partial response.
@@ -1462,12 +1459,10 @@ module Google
1462
1459
  # Search enabled. Please enable Retail Search on Cloud Console before using this
1463
1460
  # feature.
1464
1461
  # @param [String] placement
1465
- # Required. The resource name of the Retail Search serving config, such as `
1466
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1467
- # default_serving_config` or the name of the legacy placement resource, such as `
1468
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1469
- # . This field is used to identify the serving configuration name and the set of
1470
- # models that will be used to make the search.
1462
+ # Required. The resource name of the search engine placement, such as `projects/*
1463
+ # /locations/global/catalogs/default_catalog/placements/default_search`. This
1464
+ # field is used to identify the serving configuration name and the set of models
1465
+ # that will be used to make the search.
1471
1466
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1472
1467
  # @param [String] fields
1473
1468
  # Selector specifying which fields to include in a partial response.
@@ -1722,48 +1717,6 @@ module Google
1722
1717
  execute_or_queue_command(command, &block)
1723
1718
  end
1724
1719
 
1725
- # Makes a recommendation prediction.
1726
- # @param [String] placement
1727
- # Required. Full resource name of the format: `name=projects/*/locations/global/
1728
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1729
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1730
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1731
- # Recommendations AI serving config or placement. Before you can request
1732
- # predictions from your model, you must create at least one serving config or
1733
- # placement for it. For more information, see [Managing serving configurations] (
1734
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1735
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1736
- # retail/catalogs/default_catalog/configs
1737
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_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 [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
1748
- # @yieldparam err [StandardError] error object if request failed
1749
- #
1750
- # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
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 predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1756
- command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
1757
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
1758
- command.request_object = google_cloud_retail_v2alpha_predict_request_object
1759
- command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
1760
- command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
1761
- command.params['placement'] = placement unless placement.nil?
1762
- command.query['fields'] = fields unless fields.nil?
1763
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1764
- execute_or_queue_command(command, &block)
1765
- end
1766
-
1767
1720
  # Disables a Control on the specified ServingConfig. The control is removed from
1768
1721
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1769
1722
  # the ServingConfig.
@@ -1801,46 +1754,6 @@ module Google
1801
1754
  execute_or_queue_command(command, &block)
1802
1755
  end
1803
1756
 
1804
- # Performs a search. This feature is only available for users who have Retail
1805
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1806
- # feature.
1807
- # @param [String] placement
1808
- # Required. The resource name of the Retail Search serving config, such as `
1809
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1810
- # default_serving_config` or the name of the legacy placement resource, such as `
1811
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1812
- # . This field is used to identify the serving configuration name and the set of
1813
- # models that will be used to make the search.
1814
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1815
- # @param [String] fields
1816
- # Selector specifying which fields to include in a partial response.
1817
- # @param [String] quota_user
1818
- # Available to use for quota purposes for server-side applications. Can be any
1819
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1820
- # @param [Google::Apis::RequestOptions] options
1821
- # Request-specific options
1822
- #
1823
- # @yield [result, err] Result & error if block supplied
1824
- # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
1825
- # @yieldparam err [StandardError] error object if request failed
1826
- #
1827
- # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
1828
- #
1829
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1830
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1831
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1832
- def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1833
- command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
1834
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
1835
- command.request_object = google_cloud_retail_v2alpha_search_request_object
1836
- command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
1837
- command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
1838
- command.params['placement'] = placement unless placement.nil?
1839
- command.query['fields'] = fields unless fields.nil?
1840
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1841
- execute_or_queue_command(command, &block)
1842
- end
1843
-
1844
1757
  # Writes a single user event from the browser. This uses a GET request to due to
1845
1758
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1846
1759
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.37.0
4
+ version: 0.38.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-04-25 00:00:00.000000000 Z
11
+ date: 2022-05-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.37.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.38.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []