google-apis-retail_v2alpha 0.18.0 → 0.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/OVERVIEW.md +2 -2
- data/lib/google/apis/retail_v2alpha/classes.rb +228 -33
- data/lib/google/apis/retail_v2alpha/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2alpha/representations.rb +98 -0
- data/lib/google/apis/retail_v2alpha/service.rb +94 -4
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9321feea3ac3678091dc4f57385b0a7bb13be984dd8db5e63acc9e14f182a7a4
|
4
|
+
data.tar.gz: 4b08a3e9c835e3e13b2ce8cf69249198c606304b191e521983b17d4bd0924c49
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 753b6609d7dc329403cd8e0e90497382989d89cfcab43ac7ed0f327bfeda80d172cb2cd584c94ed25d0c401bfb1f356d2c44417d0d1039ccf45c4af7989c456a
|
7
|
+
data.tar.gz: c5d177645a23d928706e6aac85e755a9de4c4f35f604a63ad32f0569f189e4fdb98cb6d415efaed3456ce3098f0680219cd4326ed692a4d2e6073112c2a60709
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Release history for google-apis-retail_v2alpha
|
2
2
|
|
3
|
+
### v0.22.0 (2021-11-17)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20211116
|
6
|
+
|
7
|
+
### v0.21.0 (2021-11-10)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20211104
|
10
|
+
|
11
|
+
### v0.20.0 (2021-11-03)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20211028
|
14
|
+
|
15
|
+
### v0.19.0 (2021-10-26)
|
16
|
+
|
17
|
+
* Regenerated from discovery document revision 20211021
|
18
|
+
|
3
19
|
### v0.18.0 (2021-10-13)
|
4
20
|
|
5
21
|
* Regenerated from discovery document revision 20211011
|
data/OVERVIEW.md
CHANGED
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
|
|
60
60
|
|
61
61
|
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
62
|
|
63
|
-
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/
|
64
|
-
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
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
|
|
@@ -657,7 +657,7 @@ module Google
|
|
657
657
|
# or the region IDs for "same-day-delivery" to be added for this type. Duplicate
|
658
658
|
# IDs will be automatically ignored. At least 1 value is required, and a maximum
|
659
659
|
# of 2000 values are allowed. Each value must be a string with a length limit of
|
660
|
-
# 10 characters, matching the pattern [a-zA-Z0-9_-]
|
660
|
+
# 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
|
661
661
|
# REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
|
662
662
|
# number of place IDs exceeds 2000 for this type after adding, then the update
|
663
663
|
# will be rejected.
|
@@ -703,6 +703,86 @@ module Google
|
|
703
703
|
end
|
704
704
|
end
|
705
705
|
|
706
|
+
# Metadata related to the progress of the AddLocalInventories operation.
|
707
|
+
# Currently empty because there is no meaningful metadata populated from the
|
708
|
+
# AddLocalInventories method.
|
709
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
710
|
+
include Google::Apis::Core::Hashable
|
711
|
+
|
712
|
+
def initialize(**args)
|
713
|
+
update!(**args)
|
714
|
+
end
|
715
|
+
|
716
|
+
# Update properties of this object
|
717
|
+
def update!(**args)
|
718
|
+
end
|
719
|
+
end
|
720
|
+
|
721
|
+
# Request message for AddLocalInventories method.
|
722
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
723
|
+
include Google::Apis::Core::Hashable
|
724
|
+
|
725
|
+
# Indicates which inventory fields in the provided list of LocalInventory to
|
726
|
+
# update. The field is updated to the provided value. If a field is set while
|
727
|
+
# the place does not have a previous local inventory, the local inventory at
|
728
|
+
# that store is created. If a field is set while the value of that field is not
|
729
|
+
# provided, the original field value, if it exists, is deleted. If the mask is
|
730
|
+
# not set or set with empty paths, all inventory fields will be updated. If an
|
731
|
+
# unsupported or unknown field is provided, an INVALID_ARGUMENT error is
|
732
|
+
# returned and the entire update will be ignored.
|
733
|
+
# Corresponds to the JSON property `addMask`
|
734
|
+
# @return [String]
|
735
|
+
attr_accessor :add_mask
|
736
|
+
|
737
|
+
# The time when the inventory updates are issued. Used to prevent out-of-order
|
738
|
+
# updates on local inventory fields. If not provided, the internal system time
|
739
|
+
# will be used.
|
740
|
+
# Corresponds to the JSON property `addTime`
|
741
|
+
# @return [String]
|
742
|
+
attr_accessor :add_time
|
743
|
+
|
744
|
+
# If set to true, and the Product is not found, the local inventory will still
|
745
|
+
# be processed and retained for at most 1 day and processed once the Product is
|
746
|
+
# created. If set to false, a NOT_FOUND error is returned if the Product is not
|
747
|
+
# found.
|
748
|
+
# Corresponds to the JSON property `allowMissing`
|
749
|
+
# @return [Boolean]
|
750
|
+
attr_accessor :allow_missing
|
751
|
+
alias_method :allow_missing?, :allow_missing
|
752
|
+
|
753
|
+
# Required. A list of inventory information at difference places. Each place is
|
754
|
+
# identified by its place ID. At most 1000 inventories are allowed per request.
|
755
|
+
# Corresponds to the JSON property `localInventories`
|
756
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
|
757
|
+
attr_accessor :local_inventories
|
758
|
+
|
759
|
+
def initialize(**args)
|
760
|
+
update!(**args)
|
761
|
+
end
|
762
|
+
|
763
|
+
# Update properties of this object
|
764
|
+
def update!(**args)
|
765
|
+
@add_mask = args[:add_mask] if args.key?(:add_mask)
|
766
|
+
@add_time = args[:add_time] if args.key?(:add_time)
|
767
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
768
|
+
@local_inventories = args[:local_inventories] if args.key?(:local_inventories)
|
769
|
+
end
|
770
|
+
end
|
771
|
+
|
772
|
+
# Response of the AddLocalInventories API. Currently empty because there is no
|
773
|
+
# meaningful response populated from the AddLocalInventories method.
|
774
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
775
|
+
include Google::Apis::Core::Hashable
|
776
|
+
|
777
|
+
def initialize(**args)
|
778
|
+
update!(**args)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Update properties of this object
|
782
|
+
def update!(**args)
|
783
|
+
end
|
784
|
+
end
|
785
|
+
|
706
786
|
# An intended audience of the Product for whom it's sold.
|
707
787
|
class GoogleCloudRetailV2alphaAudience
|
708
788
|
include Google::Apis::Core::Hashable
|
@@ -1190,7 +1270,7 @@ module Google
|
|
1190
1270
|
# The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
|
1191
1271
|
# in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
|
1192
1272
|
# maximum of 3000 values are allowed. Each value must be a string with a length
|
1193
|
-
# limit of 30 characters, matching the pattern [a-zA-Z0-9_-]
|
1273
|
+
# limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
|
1194
1274
|
# or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
|
1195
1275
|
# Corresponds to the JSON property `placeIds`
|
1196
1276
|
# @return [Array<String>]
|
@@ -1480,8 +1560,8 @@ module Google
|
|
1480
1560
|
|
1481
1561
|
# Unique identifier provided by client, within the ancestor dataset scope.
|
1482
1562
|
# Ensures idempotency and used for request deduplication. Server-generated if
|
1483
|
-
# unspecified. Up to 128 characters long and must match the pattern:
|
1484
|
-
# 9_]
|
1563
|
+
# unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
|
1564
|
+
# 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
|
1485
1565
|
# when ImportProductsRequest.reconciliation_mode is set to `FULL`.
|
1486
1566
|
# Corresponds to the JSON property `requestId`
|
1487
1567
|
# @return [String]
|
@@ -1692,6 +1772,44 @@ module Google
|
|
1692
1772
|
end
|
1693
1773
|
end
|
1694
1774
|
|
1775
|
+
# The inventory information at a place (e.g. a store) identified by a place ID.
|
1776
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
1777
|
+
include Google::Apis::Core::Hashable
|
1778
|
+
|
1779
|
+
# Additional local inventory attributes, for example, store name, promotion tags,
|
1780
|
+
# etc. * At most 5 values are allowed. Otherwise, an INVALID_ARGUMENT error is
|
1781
|
+
# returned. * The key must be a UTF-8 encoded string with a length limit of 10
|
1782
|
+
# characters. * The key must match the pattern: `a-zA-Z0-9*`. For example,
|
1783
|
+
# key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same
|
1784
|
+
# type (text or number). * The max number of values per attribute is 10. * For
|
1785
|
+
# text values, the length limit is 10 UTF-8 characters. * The attribute does not
|
1786
|
+
# support search. The `searchable` field should be unset or set to false.
|
1787
|
+
# Corresponds to the JSON property `attributes`
|
1788
|
+
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
1789
|
+
attr_accessor :attributes
|
1790
|
+
|
1791
|
+
# The place ID for the current set of inventory information.
|
1792
|
+
# Corresponds to the JSON property `placeId`
|
1793
|
+
# @return [String]
|
1794
|
+
attr_accessor :place_id
|
1795
|
+
|
1796
|
+
# The price information of a Product.
|
1797
|
+
# Corresponds to the JSON property `priceInfo`
|
1798
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo]
|
1799
|
+
attr_accessor :price_info
|
1800
|
+
|
1801
|
+
def initialize(**args)
|
1802
|
+
update!(**args)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Update properties of this object
|
1806
|
+
def update!(**args)
|
1807
|
+
@attributes = args[:attributes] if args.key?(:attributes)
|
1808
|
+
@place_id = args[:place_id] if args.key?(:place_id)
|
1809
|
+
@price_info = args[:price_info] if args.key?(:price_info)
|
1810
|
+
end
|
1811
|
+
end
|
1812
|
+
|
1695
1813
|
# Represents a link between a Merchant Center account and a branch. Once a link
|
1696
1814
|
# is established, products from the linked merchant center account will be
|
1697
1815
|
# streamed to the linked branch.
|
@@ -1709,9 +1827,9 @@ module Google
|
|
1709
1827
|
|
1710
1828
|
# String representing the destination to import for, all if left empty. List of
|
1711
1829
|
# possible values can be found here. [https://support.google.com/merchants/
|
1712
|
-
# answer/7501026] List of allowed string values: "
|
1713
|
-
#
|
1714
|
-
#
|
1830
|
+
# answer/7501026] List of allowed string values: "Shopping_ads", "
|
1831
|
+
# Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings"
|
1832
|
+
# , "Free_local_listings" NOTE: The string values are case sensitive.
|
1715
1833
|
# Corresponds to the JSON property `destinations`
|
1716
1834
|
# @return [Array<String>]
|
1717
1835
|
attr_accessor :destinations
|
@@ -2042,7 +2160,7 @@ module Google
|
|
2042
2160
|
# :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
|
2043
2161
|
# INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
|
2044
2162
|
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
2045
|
-
# indexable attribute, the key must match the pattern: a-zA-Z0-9
|
2163
|
+
# indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
|
2046
2164
|
# key0LikeThis or KEY_1_LIKE_THIS.
|
2047
2165
|
# Corresponds to the JSON property `attributes`
|
2048
2166
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
@@ -2307,12 +2425,13 @@ module Google
|
|
2307
2425
|
# @return [String]
|
2308
2426
|
attr_accessor :title
|
2309
2427
|
|
2310
|
-
# Input only. The TTL (time to live) of the product. If it is set,
|
2311
|
-
# is set as current timestamp plus ttl. The
|
2312
|
-
# the output and ttl is left blank when
|
2313
|
-
# the product is not available for
|
2314
|
-
# plus ttl. However, the product
|
2315
|
-
# GetProduct and ProductService.
|
2428
|
+
# Input only. The TTL (time to live) of the product. If it is set, it must be a
|
2429
|
+
# non-negative value, and expire_time is set as current timestamp plus ttl. The
|
2430
|
+
# derived expire_time is returned in the output and ttl is left blank when
|
2431
|
+
# retrieving the Product. If it is set, the product is not available for
|
2432
|
+
# SearchService.Search after current timestamp plus ttl. However, the product
|
2433
|
+
# can still be retrieved by ProductService.GetProduct and ProductService.
|
2434
|
+
# ListProducts.
|
2316
2435
|
# Corresponds to the JSON property `ttl`
|
2317
2436
|
# @return [String]
|
2318
2437
|
attr_accessor :ttl
|
@@ -2471,15 +2590,15 @@ module Google
|
|
2471
2590
|
include Google::Apis::Core::Hashable
|
2472
2591
|
|
2473
2592
|
# The type of Products allowed to be ingested into the catalog. Acceptable
|
2474
|
-
# values are: * `primary` (default): You can
|
2475
|
-
#
|
2476
|
-
#
|
2477
|
-
#
|
2478
|
-
#
|
2479
|
-
#
|
2480
|
-
#
|
2481
|
-
#
|
2482
|
-
#
|
2593
|
+
# values are: * `primary` (default): You can ingest Products of all types. When
|
2594
|
+
# ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
|
2595
|
+
# `variant`: You can only ingest Product.Type.VARIANT Products. This means
|
2596
|
+
# Product.primary_product_id cannot be empty. If this field is set to an invalid
|
2597
|
+
# value other than these, an INVALID_ARGUMENT error is returned. If this field
|
2598
|
+
# is `variant` and merchant_center_product_id_field is `itemGroupId`, an
|
2599
|
+
# INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
|
2600
|
+
# google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
|
2601
|
+
# details.
|
2483
2602
|
# Corresponds to the JSON property `ingestionProductType`
|
2484
2603
|
# @return [String]
|
2485
2604
|
attr_accessor :ingestion_product_type
|
@@ -2514,8 +2633,8 @@ module Google
|
|
2514
2633
|
include Google::Apis::Core::Hashable
|
2515
2634
|
|
2516
2635
|
# ID of the promotion. For example, "free gift". The value value must be a UTF-8
|
2517
|
-
# encoded string with a length limit of 128 characters, and match the pattern:
|
2518
|
-
# zA-Z
|
2636
|
+
# encoded string with a length limit of 128 characters, and match the pattern: `
|
2637
|
+
# a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
|
2519
2638
|
# INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
|
2520
2639
|
# (https://support.google.com/merchants/answer/7050148).
|
2521
2640
|
# Corresponds to the JSON property `promotionId`
|
@@ -2776,7 +2895,7 @@ module Google
|
|
2776
2895
|
# or the region IDs for "same-day-delivery", to be removed for this type. At
|
2777
2896
|
# least 1 value is required, and a maximum of 2000 values are allowed. Each
|
2778
2897
|
# value must be a string with a length limit of 10 characters, matching the
|
2779
|
-
# pattern [a-zA-Z0-9_-]
|
2898
|
+
# pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
|
2780
2899
|
# INVALID_ARGUMENT error is returned.
|
2781
2900
|
# Corresponds to the JSON property `placeIds`
|
2782
2901
|
# @return [Array<String>]
|
@@ -2827,6 +2946,73 @@ module Google
|
|
2827
2946
|
end
|
2828
2947
|
end
|
2829
2948
|
|
2949
|
+
# Metadata related to the progress of the RemoveLocalInventories operation.
|
2950
|
+
# Currently empty because there is no meaningful metadata populated from the
|
2951
|
+
# RemoveLocalInventories method.
|
2952
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
2953
|
+
include Google::Apis::Core::Hashable
|
2954
|
+
|
2955
|
+
def initialize(**args)
|
2956
|
+
update!(**args)
|
2957
|
+
end
|
2958
|
+
|
2959
|
+
# Update properties of this object
|
2960
|
+
def update!(**args)
|
2961
|
+
end
|
2962
|
+
end
|
2963
|
+
|
2964
|
+
# Request message for RemoveLocalInventories method.
|
2965
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
2966
|
+
include Google::Apis::Core::Hashable
|
2967
|
+
|
2968
|
+
# If set to true, and the Product is not found, the local inventory removal
|
2969
|
+
# request will still be processed and retained for at most 1 day and processed
|
2970
|
+
# once the Product is created. If set to false, a NOT_FOUND error is returned if
|
2971
|
+
# the Product is not found.
|
2972
|
+
# Corresponds to the JSON property `allowMissing`
|
2973
|
+
# @return [Boolean]
|
2974
|
+
attr_accessor :allow_missing
|
2975
|
+
alias_method :allow_missing?, :allow_missing
|
2976
|
+
|
2977
|
+
# Required. A list of place IDs to have their inventory deleted. At most 1000
|
2978
|
+
# place IDs are allowed per request.
|
2979
|
+
# Corresponds to the JSON property `placeIds`
|
2980
|
+
# @return [Array<String>]
|
2981
|
+
attr_accessor :place_ids
|
2982
|
+
|
2983
|
+
# The time when the inventory deletions are issued. Used to prevent out-of-order
|
2984
|
+
# updates and deletions on local inventory fields. If not provided, the internal
|
2985
|
+
# system time will be used.
|
2986
|
+
# Corresponds to the JSON property `removeTime`
|
2987
|
+
# @return [String]
|
2988
|
+
attr_accessor :remove_time
|
2989
|
+
|
2990
|
+
def initialize(**args)
|
2991
|
+
update!(**args)
|
2992
|
+
end
|
2993
|
+
|
2994
|
+
# Update properties of this object
|
2995
|
+
def update!(**args)
|
2996
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
2997
|
+
@place_ids = args[:place_ids] if args.key?(:place_ids)
|
2998
|
+
@remove_time = args[:remove_time] if args.key?(:remove_time)
|
2999
|
+
end
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Response of the RemoveLocalInventories API. Currently empty because there is
|
3003
|
+
# no meaningful response populated from the RemoveLocalInventories method.
|
3004
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
3005
|
+
include Google::Apis::Core::Hashable
|
3006
|
+
|
3007
|
+
def initialize(**args)
|
3008
|
+
update!(**args)
|
3009
|
+
end
|
3010
|
+
|
3011
|
+
# Update properties of this object
|
3012
|
+
def update!(**args)
|
3013
|
+
end
|
3014
|
+
end
|
3015
|
+
|
2830
3016
|
# Request message for SearchService.Search method.
|
2831
3017
|
class GoogleCloudRetailV2alphaSearchRequest
|
2832
3018
|
include Google::Apis::Core::Hashable
|
@@ -2936,6 +3122,12 @@ module Google
|
|
2936
3122
|
# @return [String]
|
2937
3123
|
attr_accessor :relevance_threshold
|
2938
3124
|
|
3125
|
+
# The search mode of the search request. If not specified, a single search
|
3126
|
+
# request triggers both product search and faceted search.
|
3127
|
+
# Corresponds to the JSON property `searchMode`
|
3128
|
+
# @return [String]
|
3129
|
+
attr_accessor :search_mode
|
3130
|
+
|
2939
3131
|
# Information of an end user.
|
2940
3132
|
# Corresponds to the JSON property `userInfo`
|
2941
3133
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
|
@@ -2949,10 +3141,11 @@ module Google
|
|
2949
3141
|
# fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
|
2950
3142
|
# fulfillment type and "store123" is the store ID. Supported keys are: *
|
2951
3143
|
# colorFamilies * price * originalPrice * discount * inventory(place_id,price) *
|
2952
|
-
# attributes.key, where key is any key in the Product.
|
2953
|
-
#
|
2954
|
-
#
|
2955
|
-
#
|
3144
|
+
# inventory(place_id,attributes.key), where key is any key in the Product.
|
3145
|
+
# inventories.attributes map. * attributes.key, where key is any key in the
|
3146
|
+
# Product.attributes map. * pickupInStore.id, where id is any FulfillmentInfo.
|
3147
|
+
# place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where
|
3148
|
+
# id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store". *
|
2956
3149
|
# sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for
|
2957
3150
|
# FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
|
2958
3151
|
# any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". *
|
@@ -2999,6 +3192,7 @@ module Google
|
|
2999
3192
|
@query = args[:query] if args.key?(:query)
|
3000
3193
|
@query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
|
3001
3194
|
@relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
|
3195
|
+
@search_mode = args[:search_mode] if args.key?(:search_mode)
|
3002
3196
|
@user_info = args[:user_info] if args.key?(:user_info)
|
3003
3197
|
@variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
|
3004
3198
|
@visitor_id = args[:visitor_id] if args.key?(:visitor_id)
|
@@ -3176,9 +3370,10 @@ module Google
|
|
3176
3370
|
# colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
|
3177
3371
|
# * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
|
3178
3372
|
# customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
|
3179
|
-
# customFulfillment4" * "customFulfillment5" *
|
3180
|
-
#
|
3181
|
-
# price)"
|
3373
|
+
# customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
|
3374
|
+
# key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
|
3375
|
+
# attributes.key" * "inventory(place_id,price)" * "inventory(place_id,attributes.
|
3376
|
+
# key)"
|
3182
3377
|
# Corresponds to the JSON property `key`
|
3183
3378
|
# @return [String]
|
3184
3379
|
attr_accessor :key
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.22.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20211116"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -178,6 +178,24 @@ module Google
|
|
178
178
|
include Google::Apis::Core::JsonObjectSupport
|
179
179
|
end
|
180
180
|
|
181
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
182
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
|
+
|
184
|
+
include Google::Apis::Core::JsonObjectSupport
|
185
|
+
end
|
186
|
+
|
187
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
188
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
|
+
|
190
|
+
include Google::Apis::Core::JsonObjectSupport
|
191
|
+
end
|
192
|
+
|
193
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
194
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
|
+
|
196
|
+
include Google::Apis::Core::JsonObjectSupport
|
197
|
+
end
|
198
|
+
|
181
199
|
class GoogleCloudRetailV2alphaAudience
|
182
200
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
201
|
|
@@ -352,6 +370,12 @@ module Google
|
|
352
370
|
include Google::Apis::Core::JsonObjectSupport
|
353
371
|
end
|
354
372
|
|
373
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
374
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
375
|
+
|
376
|
+
include Google::Apis::Core::JsonObjectSupport
|
377
|
+
end
|
378
|
+
|
355
379
|
class GoogleCloudRetailV2alphaMerchantCenterLink
|
356
380
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
357
381
|
|
@@ -496,6 +520,24 @@ module Google
|
|
496
520
|
include Google::Apis::Core::JsonObjectSupport
|
497
521
|
end
|
498
522
|
|
523
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
524
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
525
|
+
|
526
|
+
include Google::Apis::Core::JsonObjectSupport
|
527
|
+
end
|
528
|
+
|
529
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
530
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
|
+
|
532
|
+
include Google::Apis::Core::JsonObjectSupport
|
533
|
+
end
|
534
|
+
|
535
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
536
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
537
|
+
|
538
|
+
include Google::Apis::Core::JsonObjectSupport
|
539
|
+
end
|
540
|
+
|
499
541
|
class GoogleCloudRetailV2alphaSearchRequest
|
500
542
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
501
543
|
|
@@ -982,6 +1024,29 @@ module Google
|
|
982
1024
|
end
|
983
1025
|
end
|
984
1026
|
|
1027
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
1028
|
+
# @private
|
1029
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1030
|
+
end
|
1031
|
+
end
|
1032
|
+
|
1033
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
1034
|
+
# @private
|
1035
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1036
|
+
property :add_mask, as: 'addMask'
|
1037
|
+
property :add_time, as: 'addTime'
|
1038
|
+
property :allow_missing, as: 'allowMissing'
|
1039
|
+
collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
|
1040
|
+
|
1041
|
+
end
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
1045
|
+
# @private
|
1046
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1047
|
+
end
|
1048
|
+
end
|
1049
|
+
|
985
1050
|
class GoogleCloudRetailV2alphaAudience
|
986
1051
|
# @private
|
987
1052
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1257,6 +1322,17 @@ module Google
|
|
1257
1322
|
end
|
1258
1323
|
end
|
1259
1324
|
|
1325
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
1326
|
+
# @private
|
1327
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1328
|
+
hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
|
1329
|
+
|
1330
|
+
property :place_id, as: 'placeId'
|
1331
|
+
property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo::Representation
|
1332
|
+
|
1333
|
+
end
|
1334
|
+
end
|
1335
|
+
|
1260
1336
|
class GoogleCloudRetailV2alphaMerchantCenterLink
|
1261
1337
|
# @private
|
1262
1338
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1506,6 +1582,27 @@ module Google
|
|
1506
1582
|
end
|
1507
1583
|
end
|
1508
1584
|
|
1585
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
1586
|
+
# @private
|
1587
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1588
|
+
end
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
1592
|
+
# @private
|
1593
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1594
|
+
property :allow_missing, as: 'allowMissing'
|
1595
|
+
collection :place_ids, as: 'placeIds'
|
1596
|
+
property :remove_time, as: 'removeTime'
|
1597
|
+
end
|
1598
|
+
end
|
1599
|
+
|
1600
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
1601
|
+
# @private
|
1602
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1603
|
+
end
|
1604
|
+
end
|
1605
|
+
|
1509
1606
|
class GoogleCloudRetailV2alphaSearchRequest
|
1510
1607
|
# @private
|
1511
1608
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1527,6 +1624,7 @@ module Google
|
|
1527
1624
|
property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec::Representation
|
1528
1625
|
|
1529
1626
|
property :relevance_threshold, as: 'relevanceThreshold'
|
1627
|
+
property :search_mode, as: 'searchMode'
|
1530
1628
|
property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
|
1531
1629
|
|
1532
1630
|
collection :variant_rollup_keys, as: 'variantRollupKeys'
|
@@ -67,10 +67,10 @@ module Google
|
|
67
67
|
# cloud-retail, contact Cloud Retail support team first.
|
68
68
|
# @param [String] device_type
|
69
69
|
# The device type context for completion suggestions. It is useful to apply
|
70
|
-
# different suggestions on different device types, e.g. DESKTOP
|
71
|
-
# is empty, the suggestions are across all device types. Supported formats: *
|
72
|
-
# UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with
|
73
|
-
# OTHER_
|
70
|
+
# different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
|
71
|
+
# it is empty, the suggestions are across all device types. Supported formats: *
|
72
|
+
# `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
|
73
|
+
# `OTHER_`, e.g. `OTHER_IPHONE`.
|
74
74
|
# @param [Array<String>, String] language_codes
|
75
75
|
# The list of languages of the query. This is the BCP-47 language code, such as "
|
76
76
|
# en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
|
@@ -367,6 +367,52 @@ module Google
|
|
367
367
|
execute_or_queue_command(command, &block)
|
368
368
|
end
|
369
369
|
|
370
|
+
# Updates local inventory information for a Product at a list of places, while
|
371
|
+
# respecting the last update timestamps of each inventory field. This process is
|
372
|
+
# asynchronous and does not require the Product to exist before updating
|
373
|
+
# inventory information. If the request is valid, the update will be enqueued
|
374
|
+
# and processed downstream. As a consequence, when a response is returned,
|
375
|
+
# updates are not immediately manifested in the Product queried by GetProduct or
|
376
|
+
# ListProducts. Store inventory information can only be modified using this
|
377
|
+
# method. CreateProduct and UpdateProduct has no effect on local inventories.
|
378
|
+
# This feature is only available for users who have Retail Search enabled.
|
379
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact Cloud
|
380
|
+
# sales if you are interested in using Retail Search.
|
381
|
+
# @param [String] product
|
382
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
383
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
384
|
+
# the caller does not have permission to access the Product, regardless of
|
385
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
386
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest] google_cloud_retail_v2alpha_add_local_inventories_request_object
|
387
|
+
# @param [String] fields
|
388
|
+
# Selector specifying which fields to include in a partial response.
|
389
|
+
# @param [String] quota_user
|
390
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
391
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
392
|
+
# @param [Google::Apis::RequestOptions] options
|
393
|
+
# Request-specific options
|
394
|
+
#
|
395
|
+
# @yield [result, err] Result & error if block supplied
|
396
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
397
|
+
# @yieldparam err [StandardError] error object if request failed
|
398
|
+
#
|
399
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
400
|
+
#
|
401
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
402
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
403
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
404
|
+
def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
405
|
+
command = make_simple_command(:post, 'v2alpha/{+product}:addLocalInventories', options)
|
406
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest::Representation
|
407
|
+
command.request_object = google_cloud_retail_v2alpha_add_local_inventories_request_object
|
408
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
409
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
410
|
+
command.params['product'] = product unless product.nil?
|
411
|
+
command.query['fields'] = fields unless fields.nil?
|
412
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
413
|
+
execute_or_queue_command(command, &block)
|
414
|
+
end
|
415
|
+
|
370
416
|
# Creates a Product.
|
371
417
|
# @param [String] parent
|
372
418
|
# Required. The parent catalog resource name, such as `projects/*/locations/
|
@@ -679,6 +725,50 @@ module Google
|
|
679
725
|
execute_or_queue_command(command, &block)
|
680
726
|
end
|
681
727
|
|
728
|
+
# Remove local inventory information for a Product at a list of places at a
|
729
|
+
# removal timestamp. This process is asynchronous. If the request is valid, the
|
730
|
+
# removal will be enqueued and processed downstream. As a consequence, when a
|
731
|
+
# response is returned, removals are not immediately manifested in the Product
|
732
|
+
# queried by GetProduct or ListProducts. Store inventory information can only be
|
733
|
+
# removed using this method. CreateProduct and UpdateProduct has no effect on
|
734
|
+
# local inventories. This feature is only available for users who have Retail
|
735
|
+
# Search enabled. Please submit a form [here](https://cloud.google.com/contact)
|
736
|
+
# to contact Cloud sales if you are interested in using Retail Search.
|
737
|
+
# @param [String] product
|
738
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
739
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
740
|
+
# the caller does not have permission to access the Product, regardless of
|
741
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
742
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest] google_cloud_retail_v2alpha_remove_local_inventories_request_object
|
743
|
+
# @param [String] fields
|
744
|
+
# Selector specifying which fields to include in a partial response.
|
745
|
+
# @param [String] quota_user
|
746
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
747
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
748
|
+
# @param [Google::Apis::RequestOptions] options
|
749
|
+
# Request-specific options
|
750
|
+
#
|
751
|
+
# @yield [result, err] Result & error if block supplied
|
752
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
753
|
+
# @yieldparam err [StandardError] error object if request failed
|
754
|
+
#
|
755
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
756
|
+
#
|
757
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
758
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
759
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
760
|
+
def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
761
|
+
command = make_simple_command(:post, 'v2alpha/{+product}:removeLocalInventories', options)
|
762
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest::Representation
|
763
|
+
command.request_object = google_cloud_retail_v2alpha_remove_local_inventories_request_object
|
764
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
765
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
766
|
+
command.params['product'] = product unless product.nil?
|
767
|
+
command.query['fields'] = fields unless fields.nil?
|
768
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
769
|
+
execute_or_queue_command(command, &block)
|
770
|
+
end
|
771
|
+
|
682
772
|
# Updates inventory information for a Product while respecting the last update
|
683
773
|
# timestamps of each inventory field. This process is asynchronous and does not
|
684
774
|
# require the Product to exist before updating fulfillment information. If the
|
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.
|
4
|
+
version: 0.22.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: 2021-
|
11
|
+
date: 2021-12-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -57,9 +57,9 @@ licenses:
|
|
57
57
|
- Apache-2.0
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
|
-
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.
|
62
|
-
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/
|
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.22.0
|
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: []
|
65
65
|
require_paths:
|