google-apis-retail_v2 0.88.0 → 0.90.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: 54582d1dd8e8e04af512667e123c5a7df6631974c494529d5542f36cfab3045d
4
- data.tar.gz: be0c929e09d1ea3dfd09e732325b0425944fe263fff97833e9a24071c39663bc
3
+ metadata.gz: 8c2091dc0aa4da132cfb60b360be9cb7a8f40807b3f29c19b14dea3f23de75b5
4
+ data.tar.gz: cac582b1092581a90279c16dd9e3b7d4c90e07a96ee53e14635289b496e8ec8a
5
5
  SHA512:
6
- metadata.gz: a6f128948a79c7b84aaa1c4bd46c23e7da46a53c2873aedbb47ecf3de12d1760a42349b6eea77a979f9e23ec5942428067a66a0d711406ab63626a401c1514f8
7
- data.tar.gz: df5a674f409a6708444a8f2a01dc5c274545c7d7110a39f3ec2ef84cd6612968d463d4fdca76646941db32a2e7756ba1a264c3608c4365ad1f9b7ce2f2db2163
6
+ metadata.gz: 209f8ad2e17c367889dca09d04742ddc686be9483f0b1bd5fc1b3fae3c3082ecb2795953604908d0d1a4915481e275e4da4639f6019bf8ab48c1e20a32f50b14
7
+ data.tar.gz: c69753f660048b19bb8e61909003dc5b603e7ebf20fc92a9e29d36a1d80cdae0a7f6b3870cbd5b4c3792f1c5d48cb3cd5110510c9b16380c3d86f20160f3d7d6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.90.0 (2024-02-18)
4
+
5
+ * Regenerated from discovery document revision 20240212
6
+
7
+ ### v0.89.0 (2024-02-11)
8
+
9
+ * Regenerated from discovery document revision 20240205
10
+
3
11
  ### v0.88.0 (2024-02-04)
4
12
 
5
13
  * Regenerated from discovery document revision 20240129
data/OVERVIEW.md CHANGED
@@ -1,6 +1,6 @@
1
- # Simple REST client for version V2 of the Retail API
1
+ # Simple REST client for version V2 of the Vertex AI Search for Retail API
2
2
 
3
- This is a simple client library for version V2 of the Retail API. It provides:
3
+ This is a simple client library for version V2 of the Vertex AI Search for Retail API. It provides:
4
4
 
5
5
  * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
6
  * Ruby objects for data structures related to the service.
@@ -65,7 +65,7 @@ More detailed descriptions of the Google simple REST clients are available in tw
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
67
67
 
68
- For reference information on specific calls in the Retail API, see the {Google::Apis::RetailV2::CloudRetailService class reference docs}.
68
+ For reference information on specific calls in the Vertex AI Search for Retail API, see the {Google::Apis::RetailV2::CloudRetailService class reference docs}.
69
69
 
70
70
  ## Which client should I use?
71
71
 
@@ -560,6 +560,31 @@ module Google
560
560
  end
561
561
  end
562
562
 
563
+ # A BigQuery output result.
564
+ class GoogleCloudRetailV2BigQueryOutputResult
565
+ include Google::Apis::Core::Hashable
566
+
567
+ # The ID of a BigQuery Dataset.
568
+ # Corresponds to the JSON property `datasetId`
569
+ # @return [String]
570
+ attr_accessor :dataset_id
571
+
572
+ # The ID of a BigQuery Table.
573
+ # Corresponds to the JSON property `tableId`
574
+ # @return [String]
575
+ attr_accessor :table_id
576
+
577
+ def initialize(**args)
578
+ update!(**args)
579
+ end
580
+
581
+ # Update properties of this object
582
+ def update!(**args)
583
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
584
+ @table_id = args[:table_id] if args.key?(:table_id)
585
+ end
586
+ end
587
+
563
588
  # BigQuery source import data from.
564
589
  class GoogleCloudRetailV2BigQuerySource
565
590
  include Google::Apis::Core::Hashable
@@ -1551,6 +1576,121 @@ module Google
1551
1576
  end
1552
1577
  end
1553
1578
 
1579
+ # Request message for the `ExportAnalyticsMetrics` method.
1580
+ class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
1581
+ include Google::Apis::Core::Hashable
1582
+
1583
+ # A filtering expression to specify restrictions on returned metrics. The
1584
+ # expression is a sequence of terms. Each term applies a restriction to the
1585
+ # returned metrics. Use this expression to restrict results to a specific time
1586
+ # range. Currently we expect only one types of fields: * `timestamp`: This can
1587
+ # be specified twice, once with a less than operator and once with a greater
1588
+ # than operator. The `timestamp` restriction should result in one, contiguous,
1589
+ # valid, `timestamp` range. Some examples of valid filters expressions: *
1590
+ # Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:
1591
+ # 30:43.511Z"` * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
1592
+ # Corresponds to the JSON property `filter`
1593
+ # @return [String]
1594
+ attr_accessor :filter
1595
+
1596
+ # The output configuration setting.
1597
+ # Corresponds to the JSON property `outputConfig`
1598
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig]
1599
+ attr_accessor :output_config
1600
+
1601
+ def initialize(**args)
1602
+ update!(**args)
1603
+ end
1604
+
1605
+ # Update properties of this object
1606
+ def update!(**args)
1607
+ @filter = args[:filter] if args.key?(:filter)
1608
+ @output_config = args[:output_config] if args.key?(:output_config)
1609
+ end
1610
+ end
1611
+
1612
+ # Response of the ExportAnalyticsMetricsRequest. If the long running operation
1613
+ # was successful, then this message is returned by the google.longrunning.
1614
+ # Operations.response field if the operation was successful.
1615
+ class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
1616
+ include Google::Apis::Core::Hashable
1617
+
1618
+ # A sample of errors encountered while processing the request.
1619
+ # Corresponds to the JSON property `errorSamples`
1620
+ # @return [Array<Google::Apis::RetailV2::GoogleRpcStatus>]
1621
+ attr_accessor :error_samples
1622
+
1623
+ # Configuration of destination for Export related errors.
1624
+ # Corresponds to the JSON property `errorsConfig`
1625
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig]
1626
+ attr_accessor :errors_config
1627
+
1628
+ # Output result that stores the information about where the exported data is
1629
+ # stored.
1630
+ # Corresponds to the JSON property `outputResult`
1631
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult]
1632
+ attr_accessor :output_result
1633
+
1634
+ def initialize(**args)
1635
+ update!(**args)
1636
+ end
1637
+
1638
+ # Update properties of this object
1639
+ def update!(**args)
1640
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
1641
+ @errors_config = args[:errors_config] if args.key?(:errors_config)
1642
+ @output_result = args[:output_result] if args.key?(:output_result)
1643
+ end
1644
+ end
1645
+
1646
+ # Configuration of destination for Export related errors.
1647
+ class GoogleCloudRetailV2ExportErrorsConfig
1648
+ include Google::Apis::Core::Hashable
1649
+
1650
+ # Google Cloud Storage path for import errors. This must be an empty, existing
1651
+ # Cloud Storage bucket. Export errors will be written to a file in this bucket,
1652
+ # one per line, as a JSON-encoded `google.rpc.Status` message.
1653
+ # Corresponds to the JSON property `gcsPrefix`
1654
+ # @return [String]
1655
+ attr_accessor :gcs_prefix
1656
+
1657
+ def initialize(**args)
1658
+ update!(**args)
1659
+ end
1660
+
1661
+ # Update properties of this object
1662
+ def update!(**args)
1663
+ @gcs_prefix = args[:gcs_prefix] if args.key?(:gcs_prefix)
1664
+ end
1665
+ end
1666
+
1667
+ # Metadata related to the progress of the Export operation. This is returned by
1668
+ # the google.longrunning.Operation.metadata field.
1669
+ class GoogleCloudRetailV2ExportMetadata
1670
+ include Google::Apis::Core::Hashable
1671
+
1672
+ # Operation create time.
1673
+ # Corresponds to the JSON property `createTime`
1674
+ # @return [String]
1675
+ attr_accessor :create_time
1676
+
1677
+ # Operation last update time. If the operation is done, this is also the finish
1678
+ # time.
1679
+ # Corresponds to the JSON property `updateTime`
1680
+ # @return [String]
1681
+ attr_accessor :update_time
1682
+
1683
+ def initialize(**args)
1684
+ update!(**args)
1685
+ end
1686
+
1687
+ # Update properties of this object
1688
+ def update!(**args)
1689
+ @create_time = args[:create_time] if args.key?(:create_time)
1690
+ @update_time = args[:update_time] if args.key?(:update_time)
1691
+ end
1692
+ end
1693
+
1554
1694
  # Fulfillment information, such as the store IDs for in-store pickup or region
1555
1695
  # IDs for different shipping methods.
1556
1696
  class GoogleCloudRetailV2FulfillmentInfo
@@ -1587,6 +1727,25 @@ module Google
1587
1727
  end
1588
1728
  end
1589
1729
 
1730
+ # A Gcs output result.
1731
+ class GoogleCloudRetailV2GcsOutputResult
1732
+ include Google::Apis::Core::Hashable
1733
+
1734
+ # The uri of Gcs output
1735
+ # Corresponds to the JSON property `outputUri`
1736
+ # @return [String]
1737
+ attr_accessor :output_uri
1738
+
1739
+ def initialize(**args)
1740
+ update!(**args)
1741
+ end
1742
+
1743
+ # Update properties of this object
1744
+ def update!(**args)
1745
+ @output_uri = args[:output_uri] if args.key?(:output_uri)
1746
+ end
1747
+ end
1748
+
1590
1749
  # Google Cloud Storage location for input content.
1591
1750
  class GoogleCloudRetailV2GcsSource
1592
1751
  include Google::Apis::Core::Hashable
@@ -2392,6 +2551,113 @@ module Google
2392
2551
  end
2393
2552
  end
2394
2553
 
2554
+ # The output configuration setting.
2555
+ class GoogleCloudRetailV2OutputConfig
2556
+ include Google::Apis::Core::Hashable
2557
+
2558
+ # The BigQuery output destination configuration.
2559
+ # Corresponds to the JSON property `bigqueryDestination`
2560
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination]
2561
+ attr_accessor :bigquery_destination
2562
+
2563
+ # The Google Cloud Storage output destination configuration.
2564
+ # Corresponds to the JSON property `gcsDestination`
2565
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination]
2566
+ attr_accessor :gcs_destination
2567
+
2568
+ def initialize(**args)
2569
+ update!(**args)
2570
+ end
2571
+
2572
+ # Update properties of this object
2573
+ def update!(**args)
2574
+ @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
2575
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
2576
+ end
2577
+ end
2578
+
2579
+ # The BigQuery output destination configuration.
2580
+ class GoogleCloudRetailV2OutputConfigBigQueryDestination
2581
+ include Google::Apis::Core::Hashable
2582
+
2583
+ # Required. The ID of a BigQuery Dataset.
2584
+ # Corresponds to the JSON property `datasetId`
2585
+ # @return [String]
2586
+ attr_accessor :dataset_id
2587
+
2588
+ # Required. The prefix of exported BigQuery tables.
2589
+ # Corresponds to the JSON property `tableIdPrefix`
2590
+ # @return [String]
2591
+ attr_accessor :table_id_prefix
2592
+
2593
+ # Required. Describes the table type. The following values are supported: * `
2594
+ # table`: A BigQuery native table. * `view`: A virtual table defined by a SQL
2595
+ # query.
2596
+ # Corresponds to the JSON property `tableType`
2597
+ # @return [String]
2598
+ attr_accessor :table_type
2599
+
2600
+ def initialize(**args)
2601
+ update!(**args)
2602
+ end
2603
+
2604
+ # Update properties of this object
2605
+ def update!(**args)
2606
+ @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
2607
+ @table_id_prefix = args[:table_id_prefix] if args.key?(:table_id_prefix)
2608
+ @table_type = args[:table_type] if args.key?(:table_type)
2609
+ end
2610
+ end
2611
+
2612
+ # The Google Cloud Storage output destination configuration.
2613
+ class GoogleCloudRetailV2OutputConfigGcsDestination
2614
+ include Google::Apis::Core::Hashable
2615
+
2616
+ # Required. The output uri prefix for saving output data to json files. Some
2617
+ # mapping examples are as follows: output_uri_prefix sample output(assuming the
2618
+ # object is foo.json) ======================== ==================================
2619
+ # =========== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/
2620
+ # folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
2621
+ # Corresponds to the JSON property `outputUriPrefix`
2622
+ # @return [String]
2623
+ attr_accessor :output_uri_prefix
2624
+
2625
+ def initialize(**args)
2626
+ update!(**args)
2627
+ end
2628
+
2629
+ # Update properties of this object
2630
+ def update!(**args)
2631
+ @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
2632
+ end
2633
+ end
2634
+
2635
+ # Output result that stores the information about where the exported data is
2636
+ # stored.
2637
+ class GoogleCloudRetailV2OutputResult
2638
+ include Google::Apis::Core::Hashable
2639
+
2640
+ # The BigQuery location where the result is stored.
2641
+ # Corresponds to the JSON property `bigqueryResult`
2642
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult>]
2643
+ attr_accessor :bigquery_result
2644
+
2645
+ # The Google Cloud Storage location where the result is stored.
2646
+ # Corresponds to the JSON property `gcsResult`
2647
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult>]
2648
+ attr_accessor :gcs_result
2649
+
2650
+ def initialize(**args)
2651
+ update!(**args)
2652
+ end
2653
+
2654
+ # Update properties of this object
2655
+ def update!(**args)
2656
+ @bigquery_result = args[:bigquery_result] if args.key?(:bigquery_result)
2657
+ @gcs_result = args[:gcs_result] if args.key?(:gcs_result)
2658
+ end
2659
+ end
2660
+
2395
2661
  # Request for pausing training of a model.
2396
2662
  class GoogleCloudRetailV2PauseModelRequest
2397
2663
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.88.0"
19
+ GEM_VERSION = "0.90.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.13.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240129"
25
+ REVISION = "20240212"
26
26
  end
27
27
  end
28
28
  end
@@ -124,6 +124,12 @@ module Google
124
124
  include Google::Apis::Core::JsonObjectSupport
125
125
  end
126
126
 
127
+ class GoogleCloudRetailV2BigQueryOutputResult
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
127
133
  class GoogleCloudRetailV2BigQuerySource
128
134
  class Representation < Google::Apis::Core::JsonRepresentation; end
129
135
 
@@ -262,12 +268,42 @@ module Google
262
268
  include Google::Apis::Core::JsonObjectSupport
263
269
  end
264
270
 
271
+ class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
272
+ class Representation < Google::Apis::Core::JsonRepresentation; end
273
+
274
+ include Google::Apis::Core::JsonObjectSupport
275
+ end
276
+
277
+ class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
278
+ class Representation < Google::Apis::Core::JsonRepresentation; end
279
+
280
+ include Google::Apis::Core::JsonObjectSupport
281
+ end
282
+
283
+ class GoogleCloudRetailV2ExportErrorsConfig
284
+ class Representation < Google::Apis::Core::JsonRepresentation; end
285
+
286
+ include Google::Apis::Core::JsonObjectSupport
287
+ end
288
+
289
+ class GoogleCloudRetailV2ExportMetadata
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
265
295
  class GoogleCloudRetailV2FulfillmentInfo
266
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
297
 
268
298
  include Google::Apis::Core::JsonObjectSupport
269
299
  end
270
300
 
301
+ class GoogleCloudRetailV2GcsOutputResult
302
+ class Representation < Google::Apis::Core::JsonRepresentation; end
303
+
304
+ include Google::Apis::Core::JsonObjectSupport
305
+ end
306
+
271
307
  class GoogleCloudRetailV2GcsSource
272
308
  class Representation < Google::Apis::Core::JsonRepresentation; end
273
309
 
@@ -400,6 +436,30 @@ module Google
400
436
  include Google::Apis::Core::JsonObjectSupport
401
437
  end
402
438
 
439
+ class GoogleCloudRetailV2OutputConfig
440
+ class Representation < Google::Apis::Core::JsonRepresentation; end
441
+
442
+ include Google::Apis::Core::JsonObjectSupport
443
+ end
444
+
445
+ class GoogleCloudRetailV2OutputConfigBigQueryDestination
446
+ class Representation < Google::Apis::Core::JsonRepresentation; end
447
+
448
+ include Google::Apis::Core::JsonObjectSupport
449
+ end
450
+
451
+ class GoogleCloudRetailV2OutputConfigGcsDestination
452
+ class Representation < Google::Apis::Core::JsonRepresentation; end
453
+
454
+ include Google::Apis::Core::JsonObjectSupport
455
+ end
456
+
457
+ class GoogleCloudRetailV2OutputResult
458
+ class Representation < Google::Apis::Core::JsonRepresentation; end
459
+
460
+ include Google::Apis::Core::JsonObjectSupport
461
+ end
462
+
403
463
  class GoogleCloudRetailV2PauseModelRequest
404
464
  class Representation < Google::Apis::Core::JsonRepresentation; end
405
465
 
@@ -1525,6 +1585,14 @@ module Google
1525
1585
  end
1526
1586
  end
1527
1587
 
1588
+ class GoogleCloudRetailV2BigQueryOutputResult
1589
+ # @private
1590
+ class Representation < Google::Apis::Core::JsonRepresentation
1591
+ property :dataset_id, as: 'datasetId'
1592
+ property :table_id, as: 'tableId'
1593
+ end
1594
+ end
1595
+
1528
1596
  class GoogleCloudRetailV2BigQuerySource
1529
1597
  # @private
1530
1598
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1760,6 +1828,42 @@ module Google
1760
1828
  end
1761
1829
  end
1762
1830
 
1831
+ class GoogleCloudRetailV2ExportAnalyticsMetricsRequest
1832
+ # @private
1833
+ class Representation < Google::Apis::Core::JsonRepresentation
1834
+ property :filter, as: 'filter'
1835
+ property :output_config, as: 'outputConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig::Representation
1836
+
1837
+ end
1838
+ end
1839
+
1840
+ class GoogleCloudRetailV2ExportAnalyticsMetricsResponse
1841
+ # @private
1842
+ class Representation < Google::Apis::Core::JsonRepresentation
1843
+ collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2::GoogleRpcStatus, decorator: Google::Apis::RetailV2::GoogleRpcStatus::Representation
1844
+
1845
+ property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExportErrorsConfig::Representation
1846
+
1847
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputResult::Representation
1848
+
1849
+ end
1850
+ end
1851
+
1852
+ class GoogleCloudRetailV2ExportErrorsConfig
1853
+ # @private
1854
+ class Representation < Google::Apis::Core::JsonRepresentation
1855
+ property :gcs_prefix, as: 'gcsPrefix'
1856
+ end
1857
+ end
1858
+
1859
+ class GoogleCloudRetailV2ExportMetadata
1860
+ # @private
1861
+ class Representation < Google::Apis::Core::JsonRepresentation
1862
+ property :create_time, as: 'createTime'
1863
+ property :update_time, as: 'updateTime'
1864
+ end
1865
+ end
1866
+
1763
1867
  class GoogleCloudRetailV2FulfillmentInfo
1764
1868
  # @private
1765
1869
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1768,6 +1872,13 @@ module Google
1768
1872
  end
1769
1873
  end
1770
1874
 
1875
+ class GoogleCloudRetailV2GcsOutputResult
1876
+ # @private
1877
+ class Representation < Google::Apis::Core::JsonRepresentation
1878
+ property :output_uri, as: 'outputUri'
1879
+ end
1880
+ end
1881
+
1771
1882
  class GoogleCloudRetailV2GcsSource
1772
1883
  # @private
1773
1884
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1988,6 +2099,42 @@ module Google
1988
2099
  end
1989
2100
  end
1990
2101
 
2102
+ class GoogleCloudRetailV2OutputConfig
2103
+ # @private
2104
+ class Representation < Google::Apis::Core::JsonRepresentation
2105
+ property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigBigQueryDestination::Representation
2106
+
2107
+ property :gcs_destination, as: 'gcsDestination', class: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfigGcsDestination::Representation
2108
+
2109
+ end
2110
+ end
2111
+
2112
+ class GoogleCloudRetailV2OutputConfigBigQueryDestination
2113
+ # @private
2114
+ class Representation < Google::Apis::Core::JsonRepresentation
2115
+ property :dataset_id, as: 'datasetId'
2116
+ property :table_id_prefix, as: 'tableIdPrefix'
2117
+ property :table_type, as: 'tableType'
2118
+ end
2119
+ end
2120
+
2121
+ class GoogleCloudRetailV2OutputConfigGcsDestination
2122
+ # @private
2123
+ class Representation < Google::Apis::Core::JsonRepresentation
2124
+ property :output_uri_prefix, as: 'outputUriPrefix'
2125
+ end
2126
+ end
2127
+
2128
+ class GoogleCloudRetailV2OutputResult
2129
+ # @private
2130
+ class Representation < Google::Apis::Core::JsonRepresentation
2131
+ collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2BigQueryOutputResult::Representation
2132
+
2133
+ collection :gcs_result, as: 'gcsResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GcsOutputResult::Representation
2134
+
2135
+ end
2136
+ end
2137
+
1991
2138
  class GoogleCloudRetailV2PauseModelRequest
1992
2139
  # @private
1993
2140
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -20,11 +20,12 @@ require 'google/apis/errors'
20
20
  module Google
21
21
  module Apis
22
22
  module RetailV2
23
- # Retail API
23
+ # Vertex AI Search for Retail API
24
24
  #
25
- # Cloud Retail service enables customers to build end-to-end personalized
26
- # recommendation systems without requiring a high level of expertise in machine
27
- # learning, recommendation system, or Google Cloud.
25
+ # Vertex AI Search for Retail API is made up of Retail Search, Browse and
26
+ # Recommendations. These discovery AI solutions help you implement personalized
27
+ # search, browse and recommendations, based on machine learning models, across
28
+ # your websites and mobile applications.
28
29
  #
29
30
  # @example
30
31
  # require 'google/apis/retail_v2'
@@ -134,6 +135,42 @@ module Google
134
135
  execute_or_queue_command(command, &block)
135
136
  end
136
137
 
138
+ # Exports analytics metrics. `Operation.response` is of type `
139
+ # ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `
140
+ # ExportMetadata`.
141
+ # @param [String] catalog
142
+ # Required. Full resource name of the parent catalog. Expected format: `projects/
143
+ # */locations/*/catalogs/*`
144
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest] google_cloud_retail_v2_export_analytics_metrics_request_object
145
+ # @param [String] fields
146
+ # Selector specifying which fields to include in a partial response.
147
+ # @param [String] quota_user
148
+ # Available to use for quota purposes for server-side applications. Can be any
149
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
150
+ # @param [Google::Apis::RequestOptions] options
151
+ # Request-specific options
152
+ #
153
+ # @yield [result, err] Result & error if block supplied
154
+ # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
155
+ # @yieldparam err [StandardError] error object if request failed
156
+ #
157
+ # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
158
+ #
159
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
160
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
161
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
162
+ def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
163
+ command = make_simple_command(:post, 'v2/{+catalog}:exportAnalyticsMetrics', options)
164
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest::Representation
165
+ command.request_object = google_cloud_retail_v2_export_analytics_metrics_request_object
166
+ command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
167
+ command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
168
+ command.params['catalog'] = catalog unless catalog.nil?
169
+ command.query['fields'] = fields unless fields.nil?
170
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
171
+ execute_or_queue_command(command, &block)
172
+ end
173
+
137
174
  # Gets an AttributesConfig.
138
175
  # @param [String] name
139
176
  # Required. Full AttributesConfig resource name. Format: `projects/`
@@ -19,15 +19,16 @@ require 'google/apis/retail_v2/gem_version.rb'
19
19
 
20
20
  module Google
21
21
  module Apis
22
- # Retail API
22
+ # Vertex AI Search for Retail API
23
23
  #
24
- # Cloud Retail service enables customers to build end-to-end personalized
25
- # recommendation systems without requiring a high level of expertise in machine
26
- # learning, recommendation system, or Google Cloud.
24
+ # Vertex AI Search for Retail API is made up of Retail Search, Browse and
25
+ # Recommendations. These discovery AI solutions help you implement personalized
26
+ # search, browse and recommendations, based on machine learning models, across
27
+ # your websites and mobile applications.
27
28
  #
28
29
  # @see https://cloud.google.com/recommendations
29
30
  module RetailV2
30
- # Version of the Retail API this client connects to.
31
+ # Version of the Vertex AI Search for Retail API this client connects to.
31
32
  # This is NOT the gem version.
32
33
  VERSION = 'V2'
33
34
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.88.0
4
+ version: 0.90.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: 2024-02-04 00:00:00.000000000 Z
11
+ date: 2024-02-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -30,13 +30,13 @@ dependencies:
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
33
- description: This is the simple REST client for Retail API V2. Simple REST clients
34
- are Ruby client libraries that provide access to Google services via their HTTP
35
- REST API endpoints. These libraries are generated and updated automatically based
36
- on the discovery documents published by the service, and they handle most concerns
37
- such as authentication, pagination, retry, timeouts, and logging. You can use this
38
- client to access the Retail API, but note that some services may provide a separate
39
- modern client that is easier to use.
33
+ description: This is the simple REST client for Vertex AI Search for Retail API V2.
34
+ Simple REST clients are Ruby client libraries that provide access to Google services
35
+ via their HTTP REST API endpoints. These libraries are generated and updated automatically
36
+ based on the discovery documents published by the service, and they handle most
37
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
38
+ use this client to access the Vertex AI Search for Retail API, but note that some
39
+ services may provide a separate modern client that is easier to use.
40
40
  email: googleapis-packages@google.com
41
41
  executables: []
42
42
  extensions: []
@@ -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_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.88.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.90.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -78,5 +78,5 @@ requirements: []
78
78
  rubygems_version: 3.5.3
79
79
  signing_key:
80
80
  specification_version: 4
81
- summary: Simple REST client for Retail API V2
81
+ summary: Simple REST client for Vertex AI Search for Retail API V2
82
82
  test_files: []