google-apis-retail_v2beta 0.12.0 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -279,6 +279,56 @@ module Google
279
279
  end
280
280
  end
281
281
 
282
+ # Metadata related to the progress of the AddFulfillmentPlaces operation.
283
+ # Currently empty because there is no meaningful metadata populated from the
284
+ # AddFulfillmentPlaces method.
285
+ class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
286
+ include Google::Apis::Core::Hashable
287
+
288
+ def initialize(**args)
289
+ update!(**args)
290
+ end
291
+
292
+ # Update properties of this object
293
+ def update!(**args)
294
+ end
295
+ end
296
+
297
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
298
+ # is no meaningful response populated from the AddFulfillmentPlaces method.
299
+ class GoogleCloudRetailV2AddFulfillmentPlacesResponse
300
+ include Google::Apis::Core::Hashable
301
+
302
+ def initialize(**args)
303
+ update!(**args)
304
+ end
305
+
306
+ # Update properties of this object
307
+ def update!(**args)
308
+ end
309
+ end
310
+
311
+ # Response of the ImportCompletionDataRequest. If the long running operation is
312
+ # done, this message is returned by the google.longrunning.Operations.response
313
+ # field if the operation is successful.
314
+ class GoogleCloudRetailV2ImportCompletionDataResponse
315
+ include Google::Apis::Core::Hashable
316
+
317
+ # A sample of errors encountered while processing the request.
318
+ # Corresponds to the JSON property `errorSamples`
319
+ # @return [Array<Google::Apis::RetailV2beta::GoogleRpcStatus>]
320
+ attr_accessor :error_samples
321
+
322
+ def initialize(**args)
323
+ update!(**args)
324
+ end
325
+
326
+ # Update properties of this object
327
+ def update!(**args)
328
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
329
+ end
330
+ end
331
+
282
332
  # Configuration of destination for Import related errors.
283
333
  class GoogleCloudRetailV2ImportErrorsConfig
284
334
  include Google::Apis::Core::Hashable
@@ -315,6 +365,20 @@ module Google
315
365
  # @return [Fixnum]
316
366
  attr_accessor :failure_count
317
367
 
368
+ # Pub/Sub topic for receiving notification. If this field is set, when the
369
+ # import is finished, a notification will be sent to specified Pub/Sub topic.
370
+ # The message data will be JSON string of a Operation. Format of the Pub/Sub
371
+ # topic is `projects/`project`/topics/`topic``.
372
+ # Corresponds to the JSON property `notificationPubsubTopic`
373
+ # @return [String]
374
+ attr_accessor :notification_pubsub_topic
375
+
376
+ # Id of the request / operation. This is parroting back the requestId that was
377
+ # passed in the request.
378
+ # Corresponds to the JSON property `requestId`
379
+ # @return [String]
380
+ attr_accessor :request_id
381
+
318
382
  # Count of entries that were processed successfully.
319
383
  # Corresponds to the JSON property `successCount`
320
384
  # @return [Fixnum]
@@ -334,6 +398,8 @@ module Google
334
398
  def update!(**args)
335
399
  @create_time = args[:create_time] if args.key?(:create_time)
336
400
  @failure_count = args[:failure_count] if args.key?(:failure_count)
401
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
402
+ @request_id = args[:request_id] if args.key?(:request_id)
337
403
  @success_count = args[:success_count] if args.key?(:success_count)
338
404
  @update_time = args[:update_time] if args.key?(:update_time)
339
405
  end
@@ -467,6 +533,64 @@ module Google
467
533
  end
468
534
  end
469
535
 
536
+ # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
537
+ # Currently empty because there is no meaningful metadata populated from the
538
+ # RemoveFulfillmentPlaces method.
539
+ class GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata
540
+ include Google::Apis::Core::Hashable
541
+
542
+ def initialize(**args)
543
+ update!(**args)
544
+ end
545
+
546
+ # Update properties of this object
547
+ def update!(**args)
548
+ end
549
+ end
550
+
551
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
552
+ # is no meaningful response populated from the RemoveFulfillmentPlaces method.
553
+ class GoogleCloudRetailV2RemoveFulfillmentPlacesResponse
554
+ include Google::Apis::Core::Hashable
555
+
556
+ def initialize(**args)
557
+ update!(**args)
558
+ end
559
+
560
+ # Update properties of this object
561
+ def update!(**args)
562
+ end
563
+ end
564
+
565
+ # Metadata related to the progress of the SetInventory operation. Currently
566
+ # empty because there is no meaningful metadata populated from the SetInventory
567
+ # method.
568
+ class GoogleCloudRetailV2SetInventoryMetadata
569
+ include Google::Apis::Core::Hashable
570
+
571
+ def initialize(**args)
572
+ update!(**args)
573
+ end
574
+
575
+ # Update properties of this object
576
+ def update!(**args)
577
+ end
578
+ end
579
+
580
+ # Response of the SetInventoryRequest. Currently empty because there is no
581
+ # meaningful response populated from the SetInventory method.
582
+ class GoogleCloudRetailV2SetInventoryResponse
583
+ include Google::Apis::Core::Hashable
584
+
585
+ def initialize(**args)
586
+ update!(**args)
587
+ end
588
+
589
+ # Update properties of this object
590
+ def update!(**args)
591
+ end
592
+ end
593
+
470
594
  # A summary of import result. The UserEventImportSummary summarizes the import
471
595
  # status for user events.
472
596
  class GoogleCloudRetailV2UserEventImportSummary
@@ -494,6 +618,49 @@ module Google
494
618
  end
495
619
  end
496
620
 
621
+ # Metadata related to the progress of the AddFulfillmentPlaces operation.
622
+ # Currently empty because there is no meaningful metadata populated from the
623
+ # AddFulfillmentPlaces method.
624
+ class GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata
625
+ include Google::Apis::Core::Hashable
626
+
627
+ def initialize(**args)
628
+ update!(**args)
629
+ end
630
+
631
+ # Update properties of this object
632
+ def update!(**args)
633
+ end
634
+ end
635
+
636
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
637
+ # is no meaningful response populated from the AddFulfillmentPlaces method.
638
+ class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
639
+ include Google::Apis::Core::Hashable
640
+
641
+ def initialize(**args)
642
+ update!(**args)
643
+ end
644
+
645
+ # Update properties of this object
646
+ def update!(**args)
647
+ end
648
+ end
649
+
650
+ # Metadata related to the EnrollSolution method. This will be returned by the
651
+ # google.longrunning.Operation.metadata field.
652
+ class GoogleCloudRetailV2alphaEnrollSolutionMetadata
653
+ include Google::Apis::Core::Hashable
654
+
655
+ def initialize(**args)
656
+ update!(**args)
657
+ end
658
+
659
+ # Update properties of this object
660
+ def update!(**args)
661
+ end
662
+ end
663
+
497
664
  # Configuration of destination for Export related errors.
498
665
  class GoogleCloudRetailV2alphaExportErrorsConfig
499
666
  include Google::Apis::Core::Hashable
@@ -596,6 +763,27 @@ module Google
596
763
  end
597
764
  end
598
765
 
766
+ # Response of the ImportCompletionDataRequest. If the long running operation is
767
+ # done, this message is returned by the google.longrunning.Operations.response
768
+ # field if the operation is successful.
769
+ class GoogleCloudRetailV2alphaImportCompletionDataResponse
770
+ include Google::Apis::Core::Hashable
771
+
772
+ # A sample of errors encountered while processing the request.
773
+ # Corresponds to the JSON property `errorSamples`
774
+ # @return [Array<Google::Apis::RetailV2beta::GoogleRpcStatus>]
775
+ attr_accessor :error_samples
776
+
777
+ def initialize(**args)
778
+ update!(**args)
779
+ end
780
+
781
+ # Update properties of this object
782
+ def update!(**args)
783
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
784
+ end
785
+ end
786
+
599
787
  # Configuration of destination for Import related errors.
600
788
  class GoogleCloudRetailV2alphaImportErrorsConfig
601
789
  include Google::Apis::Core::Hashable
@@ -632,6 +820,20 @@ module Google
632
820
  # @return [Fixnum]
633
821
  attr_accessor :failure_count
634
822
 
823
+ # Pub/Sub topic for receiving notification. If this field is set, when the
824
+ # import is finished, a notification will be sent to specified Pub/Sub topic.
825
+ # The message data will be JSON string of a Operation. Format of the Pub/Sub
826
+ # topic is `projects/`project`/topics/`topic``.
827
+ # Corresponds to the JSON property `notificationPubsubTopic`
828
+ # @return [String]
829
+ attr_accessor :notification_pubsub_topic
830
+
831
+ # Id of the request / operation. This is parroting back the requestId that was
832
+ # passed in the request.
833
+ # Corresponds to the JSON property `requestId`
834
+ # @return [String]
835
+ attr_accessor :request_id
836
+
635
837
  # Count of entries that were processed successfully.
636
838
  # Corresponds to the JSON property `successCount`
637
839
  # @return [Fixnum]
@@ -651,6 +853,8 @@ module Google
651
853
  def update!(**args)
652
854
  @create_time = args[:create_time] if args.key?(:create_time)
653
855
  @failure_count = args[:failure_count] if args.key?(:failure_count)
856
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
857
+ @request_id = args[:request_id] if args.key?(:request_id)
654
858
  @success_count = args[:success_count] if args.key?(:success_count)
655
859
  @update_time = args[:update_time] if args.key?(:update_time)
656
860
  end
@@ -784,6 +988,64 @@ module Google
784
988
  end
785
989
  end
786
990
 
991
+ # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
992
+ # Currently empty because there is no meaningful metadata populated from the
993
+ # RemoveFulfillmentPlaces method.
994
+ class GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata
995
+ include Google::Apis::Core::Hashable
996
+
997
+ def initialize(**args)
998
+ update!(**args)
999
+ end
1000
+
1001
+ # Update properties of this object
1002
+ def update!(**args)
1003
+ end
1004
+ end
1005
+
1006
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
1007
+ # is no meaningful response populated from the RemoveFulfillmentPlaces method.
1008
+ class GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse
1009
+ include Google::Apis::Core::Hashable
1010
+
1011
+ def initialize(**args)
1012
+ update!(**args)
1013
+ end
1014
+
1015
+ # Update properties of this object
1016
+ def update!(**args)
1017
+ end
1018
+ end
1019
+
1020
+ # Metadata related to the progress of the SetInventory operation. Currently
1021
+ # empty because there is no meaningful metadata populated from the SetInventory
1022
+ # method.
1023
+ class GoogleCloudRetailV2alphaSetInventoryMetadata
1024
+ include Google::Apis::Core::Hashable
1025
+
1026
+ def initialize(**args)
1027
+ update!(**args)
1028
+ end
1029
+
1030
+ # Update properties of this object
1031
+ def update!(**args)
1032
+ end
1033
+ end
1034
+
1035
+ # Response of the SetInventoryRequest. Currently empty because there is no
1036
+ # meaningful response populated from the SetInventory method.
1037
+ class GoogleCloudRetailV2alphaSetInventoryResponse
1038
+ include Google::Apis::Core::Hashable
1039
+
1040
+ def initialize(**args)
1041
+ update!(**args)
1042
+ end
1043
+
1044
+ # Update properties of this object
1045
+ def update!(**args)
1046
+ end
1047
+ end
1048
+
787
1049
  # A summary of import result. The UserEventImportSummary summarizes the import
788
1050
  # status for user events.
789
1051
  class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -811,6 +1073,129 @@ module Google
811
1073
  end
812
1074
  end
813
1075
 
1076
+ # Metadata related to the progress of the AddFulfillmentPlaces operation.
1077
+ # Currently empty because there is no meaningful metadata populated from the
1078
+ # AddFulfillmentPlaces method.
1079
+ class GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata
1080
+ include Google::Apis::Core::Hashable
1081
+
1082
+ def initialize(**args)
1083
+ update!(**args)
1084
+ end
1085
+
1086
+ # Update properties of this object
1087
+ def update!(**args)
1088
+ end
1089
+ end
1090
+
1091
+ # Request message for AddFulfillmentPlaces method.
1092
+ class GoogleCloudRetailV2betaAddFulfillmentPlacesRequest
1093
+ include Google::Apis::Core::Hashable
1094
+
1095
+ # The time when the fulfillment updates are issued, used to prevent out-of-order
1096
+ # updates on fulfillment information. If not provided, the internal system time
1097
+ # will be used.
1098
+ # Corresponds to the JSON property `addTime`
1099
+ # @return [String]
1100
+ attr_accessor :add_time
1101
+
1102
+ # If set to true, and the Product is not found, the fulfillment information will
1103
+ # still be processed and retained for at most 1 day and processed once the
1104
+ # Product is created. If set to false, an INVALID_ARGUMENT error is returned if
1105
+ # the Product is not found.
1106
+ # Corresponds to the JSON property `allowMissing`
1107
+ # @return [Boolean]
1108
+ attr_accessor :allow_missing
1109
+ alias_method :allow_missing?, :allow_missing
1110
+
1111
+ # Required. The IDs for this type, such as the store IDs for "pickup-in-store"
1112
+ # or the region IDs for "same-day-delivery" to be added for this type. Duplicate
1113
+ # IDs will be automatically ignored. At least 1 value is required, and a maximum
1114
+ # of 2000 values are allowed. Each value must be a string with a length limit of
1115
+ # 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "
1116
+ # REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
1117
+ # number of place IDs exceeds 2000 for this type after adding, then the update
1118
+ # will be rejected.
1119
+ # Corresponds to the JSON property `placeIds`
1120
+ # @return [Array<String>]
1121
+ attr_accessor :place_ids
1122
+
1123
+ # Required. The fulfillment type, including commonly used types (such as pickup
1124
+ # in store and same day delivery), and custom types. Supported values: * "pickup-
1125
+ # in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "
1126
+ # custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-
1127
+ # type-5" If this field is set to an invalid value other than these, an
1128
+ # INVALID_ARGUMENT error is returned. This field directly corresponds to Product.
1129
+ # fulfillment_info.type.
1130
+ # Corresponds to the JSON property `type`
1131
+ # @return [String]
1132
+ attr_accessor :type
1133
+
1134
+ def initialize(**args)
1135
+ update!(**args)
1136
+ end
1137
+
1138
+ # Update properties of this object
1139
+ def update!(**args)
1140
+ @add_time = args[:add_time] if args.key?(:add_time)
1141
+ @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
1142
+ @place_ids = args[:place_ids] if args.key?(:place_ids)
1143
+ @type = args[:type] if args.key?(:type)
1144
+ end
1145
+ end
1146
+
1147
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
1148
+ # is no meaningful response populated from the AddFulfillmentPlaces method.
1149
+ class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
1150
+ include Google::Apis::Core::Hashable
1151
+
1152
+ def initialize(**args)
1153
+ update!(**args)
1154
+ end
1155
+
1156
+ # Update properties of this object
1157
+ def update!(**args)
1158
+ end
1159
+ end
1160
+
1161
+ # An intended audience of the Product for whom it's sold.
1162
+ class GoogleCloudRetailV2betaAudience
1163
+ include Google::Apis::Core::Hashable
1164
+
1165
+ # The age groups of the audience. Strongly encouraged to use the standard values:
1166
+ # "newborn" (up to 3 months old), "infant" (3–12 months old), "toddler" (1–5
1167
+ # years old), "kids" (5–13 years old), "adult" (typically teens or older). At
1168
+ # most 5 values are allowed. Each value must be a UTF-8 encoded string with a
1169
+ # length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
1170
+ # returned. Google Merchant Center property [age_group](https://support.google.
1171
+ # com/merchants/answer/6324463). Schema.org property [Product.audience.
1172
+ # suggestedMinAge](https://schema.org/suggestedMinAge) and [Product.audience.
1173
+ # suggestedMaxAge](https://schema.org/suggestedMaxAge).
1174
+ # Corresponds to the JSON property `ageGroups`
1175
+ # @return [Array<String>]
1176
+ attr_accessor :age_groups
1177
+
1178
+ # The genders of the audience. Strongly encouraged to use the standard values: "
1179
+ # male", "female", "unisex". At most 5 values are allowed. Each value must be a
1180
+ # UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
1181
+ # INVALID_ARGUMENT error is returned. Google Merchant Center property [gender](
1182
+ # https://support.google.com/merchants/answer/6324479). Schema.org property [
1183
+ # Product.audience.suggestedGender](https://schema.org/suggestedGender).
1184
+ # Corresponds to the JSON property `genders`
1185
+ # @return [Array<String>]
1186
+ attr_accessor :genders
1187
+
1188
+ def initialize(**args)
1189
+ update!(**args)
1190
+ end
1191
+
1192
+ # Update properties of this object
1193
+ def update!(**args)
1194
+ @age_groups = args[:age_groups] if args.key?(:age_groups)
1195
+ @genders = args[:genders] if args.key?(:genders)
1196
+ end
1197
+ end
1198
+
814
1199
  # BigQuery source import data from.
815
1200
  class GoogleCloudRetailV2betaBigQuerySource
816
1201
  include Google::Apis::Core::Hashable
@@ -821,8 +1206,7 @@ module Google
821
1206
  # Importing catalog data from Merchant Center](https://cloud.google.com/retail/
822
1207
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
823
1208
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
824
- # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?
825
- # hl=en.
1209
+ # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
826
1210
  # Corresponds to the JSON property `dataSchema`
827
1211
  # @return [String]
828
1212
  attr_accessor :data_schema
@@ -840,6 +1224,18 @@ module Google
840
1224
  # @return [String]
841
1225
  attr_accessor :gcs_staging_dir
842
1226
 
1227
+ # Represents a whole or partial calendar date, such as a birthday. The time of
1228
+ # day and time zone are either specified elsewhere or are insignificant. The
1229
+ # date is relative to the Gregorian Calendar. This can represent one of the
1230
+ # following: * A full date, with non-zero year, month, and day values * A month
1231
+ # and day value, with a zero year, such as an anniversary * A year on its own,
1232
+ # with zero month and day values * A year and month value, with a zero day, such
1233
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
1234
+ # google.protobuf.Timestamp`.
1235
+ # Corresponds to the JSON property `partitionDate`
1236
+ # @return [Google::Apis::RetailV2beta::GoogleTypeDate]
1237
+ attr_accessor :partition_date
1238
+
843
1239
  # The project ID (can be project # or ID) that the BigQuery source is in with a
844
1240
  # length limit of 128 characters. If not specified, inherits the project ID from
845
1241
  # the parent request.
@@ -862,6 +1258,7 @@ module Google
862
1258
  @data_schema = args[:data_schema] if args.key?(:data_schema)
863
1259
  @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
864
1260
  @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
1261
+ @partition_date = args[:partition_date] if args.key?(:partition_date)
865
1262
  @project_id = args[:project_id] if args.key?(:project_id)
866
1263
  @table_id = args[:table_id] if args.key?(:table_id)
867
1264
  end
@@ -901,21 +1298,216 @@ module Google
901
1298
  end
902
1299
  end
903
1300
 
904
- # A custom attribute that is not explicitly modeled in Product.
905
- class GoogleCloudRetailV2betaCustomAttribute
1301
+ # The color information of a Product.
1302
+ class GoogleCloudRetailV2betaColorInfo
906
1303
  include Google::Apis::Core::Hashable
907
1304
 
908
- # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
909
- # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
910
- # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
911
- # set. Otherwise, an INVALID_ARGUMENT error is returned.
912
- # Corresponds to the JSON property `numbers`
913
- # @return [Array<Float>]
914
- attr_accessor :numbers
1305
+ # The standard color families. Strongly recommended to use the following
1306
+ # standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "
1307
+ # Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is
1308
+ # expected to have only 1 color family. May consider using single "Mixed"
1309
+ # instead of multiple values. A maximum of 5 values are allowed. Each value must
1310
+ # be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
1311
+ # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
1312
+ # https://support.google.com/merchants/answer/6324487). Schema.org property [
1313
+ # Product.color](https://schema.org/color).
1314
+ # Corresponds to the JSON property `colorFamilies`
1315
+ # @return [Array<String>]
1316
+ attr_accessor :color_families
1317
+
1318
+ # The color display names, which may be different from standard color family
1319
+ # names, such as the color aliases used in the website frontend. Normally it is
1320
+ # expected to have only 1 color. May consider using single "Mixed" instead of
1321
+ # multiple values. A maximum of 25 colors are allowed. Each value must be a UTF-
1322
+ # 8 encoded string with a length limit of 128 characters. Otherwise, an
1323
+ # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
1324
+ # https://support.google.com/merchants/answer/6324487). Schema.org property [
1325
+ # Product.color](https://schema.org/color).
1326
+ # Corresponds to the JSON property `colors`
1327
+ # @return [Array<String>]
1328
+ attr_accessor :colors
915
1329
 
916
- # The textual values of this custom attribute. For example, `["yellow", "green"]`
917
- # when the key is "color". At most 400 values are allowed. Empty values are not
918
- # allowed. Each value must be a UTF-8 encoded string with a length limit of 256
1330
+ def initialize(**args)
1331
+ update!(**args)
1332
+ end
1333
+
1334
+ # Update properties of this object
1335
+ def update!(**args)
1336
+ @color_families = args[:color_families] if args.key?(:color_families)
1337
+ @colors = args[:colors] if args.key?(:colors)
1338
+ end
1339
+ end
1340
+
1341
+ # Response of the auto-complete query.
1342
+ class GoogleCloudRetailV2betaCompleteQueryResponse
1343
+ include Google::Apis::Core::Hashable
1344
+
1345
+ # A unique complete token. This should be included in the SearchRequest
1346
+ # resulting from this completion, which enables accurate attribution of complete
1347
+ # model performance.
1348
+ # Corresponds to the JSON property `attributionToken`
1349
+ # @return [String]
1350
+ attr_accessor :attribution_token
1351
+
1352
+ # Results of the matching suggestions. The result list is ordered and the first
1353
+ # result is top suggestion.
1354
+ # Corresponds to the JSON property `completionResults`
1355
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult>]
1356
+ attr_accessor :completion_results
1357
+
1358
+ # Matched recent searches of this user. The maximum number of recent searches is
1359
+ # 10. This field is a restricted feature. Contact Retail Search support team if
1360
+ # you are interested in enabling it. This feature is only available when
1361
+ # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
1362
+ # recent searches satisfy the follow rules: * They are ordered from latest to
1363
+ # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
1364
+ # * They are transformed to lower cases. * They are UTF-8 safe. Recent searches
1365
+ # are deduplicated. More recent searches will be reserved when duplication
1366
+ # happens.
1367
+ # Corresponds to the JSON property `recentSearchResults`
1368
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult>]
1369
+ attr_accessor :recent_search_results
1370
+
1371
+ def initialize(**args)
1372
+ update!(**args)
1373
+ end
1374
+
1375
+ # Update properties of this object
1376
+ def update!(**args)
1377
+ @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
1378
+ @completion_results = args[:completion_results] if args.key?(:completion_results)
1379
+ @recent_search_results = args[:recent_search_results] if args.key?(:recent_search_results)
1380
+ end
1381
+ end
1382
+
1383
+ # Resource that represents completion results.
1384
+ class GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult
1385
+ include Google::Apis::Core::Hashable
1386
+
1387
+ # Additional custom attributes ingested through BigQuery.
1388
+ # Corresponds to the JSON property `attributes`
1389
+ # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
1390
+ attr_accessor :attributes
1391
+
1392
+ # The suggestion for the query.
1393
+ # Corresponds to the JSON property `suggestion`
1394
+ # @return [String]
1395
+ attr_accessor :suggestion
1396
+
1397
+ def initialize(**args)
1398
+ update!(**args)
1399
+ end
1400
+
1401
+ # Update properties of this object
1402
+ def update!(**args)
1403
+ @attributes = args[:attributes] if args.key?(:attributes)
1404
+ @suggestion = args[:suggestion] if args.key?(:suggestion)
1405
+ end
1406
+ end
1407
+
1408
+ # Recent search of this user.
1409
+ class GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult
1410
+ include Google::Apis::Core::Hashable
1411
+
1412
+ # The recent search query.
1413
+ # Corresponds to the JSON property `recentSearch`
1414
+ # @return [String]
1415
+ attr_accessor :recent_search
1416
+
1417
+ def initialize(**args)
1418
+ update!(**args)
1419
+ end
1420
+
1421
+ # Update properties of this object
1422
+ def update!(**args)
1423
+ @recent_search = args[:recent_search] if args.key?(:recent_search)
1424
+ end
1425
+ end
1426
+
1427
+ # The input config source for completion data.
1428
+ class GoogleCloudRetailV2betaCompletionDataInputConfig
1429
+ include Google::Apis::Core::Hashable
1430
+
1431
+ # BigQuery source import data from.
1432
+ # Corresponds to the JSON property `bigQuerySource`
1433
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBigQuerySource]
1434
+ attr_accessor :big_query_source
1435
+
1436
+ def initialize(**args)
1437
+ update!(**args)
1438
+ end
1439
+
1440
+ # Update properties of this object
1441
+ def update!(**args)
1442
+ @big_query_source = args[:big_query_source] if args.key?(:big_query_source)
1443
+ end
1444
+ end
1445
+
1446
+ # Detailed completion information including completion attribution token and
1447
+ # clicked completion info.
1448
+ class GoogleCloudRetailV2betaCompletionDetail
1449
+ include Google::Apis::Core::Hashable
1450
+
1451
+ # Completion attribution token in CompleteQueryResponse.attribution_token.
1452
+ # Corresponds to the JSON property `completionAttributionToken`
1453
+ # @return [String]
1454
+ attr_accessor :completion_attribution_token
1455
+
1456
+ # End user selected CompleteQueryResponse.CompletionResult.suggestion position,
1457
+ # starting from 0.
1458
+ # Corresponds to the JSON property `selectedPosition`
1459
+ # @return [Fixnum]
1460
+ attr_accessor :selected_position
1461
+
1462
+ # End user selected CompleteQueryResponse.CompletionResult.suggestion.
1463
+ # Corresponds to the JSON property `selectedSuggestion`
1464
+ # @return [String]
1465
+ attr_accessor :selected_suggestion
1466
+
1467
+ def initialize(**args)
1468
+ update!(**args)
1469
+ end
1470
+
1471
+ # Update properties of this object
1472
+ def update!(**args)
1473
+ @completion_attribution_token = args[:completion_attribution_token] if args.key?(:completion_attribution_token)
1474
+ @selected_position = args[:selected_position] if args.key?(:selected_position)
1475
+ @selected_suggestion = args[:selected_suggestion] if args.key?(:selected_suggestion)
1476
+ end
1477
+ end
1478
+
1479
+ # A custom attribute that is not explicitly modeled in Product.
1480
+ class GoogleCloudRetailV2betaCustomAttribute
1481
+ include Google::Apis::Core::Hashable
1482
+
1483
+ # If true, custom attribute values are indexed, so that it can be filtered,
1484
+ # faceted or boosted in SearchService.Search. This field is ignored in a
1485
+ # UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
1486
+ # SearchRequest.boost_spec for more details.
1487
+ # Corresponds to the JSON property `indexable`
1488
+ # @return [Boolean]
1489
+ attr_accessor :indexable
1490
+ alias_method :indexable?, :indexable
1491
+
1492
+ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
1493
+ # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
1494
+ # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
1495
+ # set. Otherwise, an INVALID_ARGUMENT error is returned.
1496
+ # Corresponds to the JSON property `numbers`
1497
+ # @return [Array<Float>]
1498
+ attr_accessor :numbers
1499
+
1500
+ # If true, custom attribute values are searchable by text queries in
1501
+ # SearchService.Search. This field is ignored in a UserEvent. Only set if type
1502
+ # text is set. Otherwise, a INVALID_ARGUMENT error is returned.
1503
+ # Corresponds to the JSON property `searchable`
1504
+ # @return [Boolean]
1505
+ attr_accessor :searchable
1506
+ alias_method :searchable?, :searchable
1507
+
1508
+ # The textual values of this custom attribute. For example, `["yellow", "green"]`
1509
+ # when the key is "color". At most 400 values are allowed. Empty values are not
1510
+ # allowed. Each value must be a UTF-8 encoded string with a length limit of 256
919
1511
  # characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
920
1512
  # text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
921
1513
  # returned.
@@ -929,7 +1521,9 @@ module Google
929
1521
 
930
1522
  # Update properties of this object
931
1523
  def update!(**args)
1524
+ @indexable = args[:indexable] if args.key?(:indexable)
932
1525
  @numbers = args[:numbers] if args.key?(:numbers)
1526
+ @searchable = args[:searchable] if args.key?(:searchable)
933
1527
  @text = args[:text] if args.key?(:text)
934
1528
  end
935
1529
  end
@@ -1036,6 +1630,42 @@ module Google
1036
1630
  end
1037
1631
  end
1038
1632
 
1633
+ # Fulfillment information, such as the store IDs for in-store pickup or region
1634
+ # IDs for different shipping methods.
1635
+ class GoogleCloudRetailV2betaFulfillmentInfo
1636
+ include Google::Apis::Core::Hashable
1637
+
1638
+ # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
1639
+ # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
1640
+ # maximum of 3000 values are allowed. Each value must be a string with a length
1641
+ # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
1642
+ # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
1643
+ # Corresponds to the JSON property `placeIds`
1644
+ # @return [Array<String>]
1645
+ attr_accessor :place_ids
1646
+
1647
+ # The fulfillment type, including commonly used types (such as pickup in store
1648
+ # and same day delivery), and custom types. Customers have to map custom types
1649
+ # to their display names before rendering UI. Supported values: * "pickup-in-
1650
+ # store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-
1651
+ # type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5"
1652
+ # If this field is set to an invalid value other than these, an
1653
+ # INVALID_ARGUMENT error is returned.
1654
+ # Corresponds to the JSON property `type`
1655
+ # @return [String]
1656
+ attr_accessor :type
1657
+
1658
+ def initialize(**args)
1659
+ update!(**args)
1660
+ end
1661
+
1662
+ # Update properties of this object
1663
+ def update!(**args)
1664
+ @place_ids = args[:place_ids] if args.key?(:place_ids)
1665
+ @type = args[:type] if args.key?(:type)
1666
+ end
1667
+ end
1668
+
1039
1669
  # Google Cloud Storage location for input content. format.
1040
1670
  class GoogleCloudRetailV2betaGcsSource
1041
1671
  include Google::Apis::Core::Hashable
@@ -1046,8 +1676,7 @@ module Google
1046
1676
  # Importing catalog data from Merchant Center](https://cloud.google.com/retail/
1047
1677
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
1048
1678
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
1049
- # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?
1050
- # hl=en.
1679
+ # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
1051
1680
  # Corresponds to the JSON property `dataSchema`
1052
1681
  # @return [String]
1053
1682
  attr_accessor :data_schema
@@ -1074,6 +1703,38 @@ module Google
1074
1703
  end
1075
1704
  end
1076
1705
 
1706
+ # Response message of CatalogService.GetDefaultBranch.
1707
+ class GoogleCloudRetailV2betaGetDefaultBranchResponse
1708
+ include Google::Apis::Core::Hashable
1709
+
1710
+ # Full resource name of the branch id currently set as default branch.
1711
+ # Corresponds to the JSON property `branch`
1712
+ # @return [String]
1713
+ attr_accessor :branch
1714
+
1715
+ # This corresponds to SetDefaultBranchRequest.note field, when this branch was
1716
+ # set as default.
1717
+ # Corresponds to the JSON property `note`
1718
+ # @return [String]
1719
+ attr_accessor :note
1720
+
1721
+ # The time when this branch is set to default.
1722
+ # Corresponds to the JSON property `setTime`
1723
+ # @return [String]
1724
+ attr_accessor :set_time
1725
+
1726
+ def initialize(**args)
1727
+ update!(**args)
1728
+ end
1729
+
1730
+ # Update properties of this object
1731
+ def update!(**args)
1732
+ @branch = args[:branch] if args.key?(:branch)
1733
+ @note = args[:note] if args.key?(:note)
1734
+ @set_time = args[:set_time] if args.key?(:set_time)
1735
+ end
1736
+ end
1737
+
1077
1738
  # Product thumbnail/detail image.
1078
1739
  class GoogleCloudRetailV2betaImage
1079
1740
  include Google::Apis::Core::Hashable
@@ -1111,6 +1772,55 @@ module Google
1111
1772
  end
1112
1773
  end
1113
1774
 
1775
+ # Request message for ImportCompletionData methods.
1776
+ class GoogleCloudRetailV2betaImportCompletionDataRequest
1777
+ include Google::Apis::Core::Hashable
1778
+
1779
+ # The input config source for completion data.
1780
+ # Corresponds to the JSON property `inputConfig`
1781
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig]
1782
+ attr_accessor :input_config
1783
+
1784
+ # Pub/Sub topic for receiving notification. If this field is set, when the
1785
+ # import is finished, a notification will be sent to specified Pub/Sub topic.
1786
+ # The message data will be JSON string of a Operation. Format of the Pub/Sub
1787
+ # topic is `projects/`project`/topics/`topic``.
1788
+ # Corresponds to the JSON property `notificationPubsubTopic`
1789
+ # @return [String]
1790
+ attr_accessor :notification_pubsub_topic
1791
+
1792
+ def initialize(**args)
1793
+ update!(**args)
1794
+ end
1795
+
1796
+ # Update properties of this object
1797
+ def update!(**args)
1798
+ @input_config = args[:input_config] if args.key?(:input_config)
1799
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
1800
+ end
1801
+ end
1802
+
1803
+ # Response of the ImportCompletionDataRequest. If the long running operation is
1804
+ # done, this message is returned by the google.longrunning.Operations.response
1805
+ # field if the operation is successful.
1806
+ class GoogleCloudRetailV2betaImportCompletionDataResponse
1807
+ include Google::Apis::Core::Hashable
1808
+
1809
+ # A sample of errors encountered while processing the request.
1810
+ # Corresponds to the JSON property `errorSamples`
1811
+ # @return [Array<Google::Apis::RetailV2beta::GoogleRpcStatus>]
1812
+ attr_accessor :error_samples
1813
+
1814
+ def initialize(**args)
1815
+ update!(**args)
1816
+ end
1817
+
1818
+ # Update properties of this object
1819
+ def update!(**args)
1820
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
1821
+ end
1822
+ end
1823
+
1114
1824
  # Configuration of destination for Import related errors.
1115
1825
  class GoogleCloudRetailV2betaImportErrorsConfig
1116
1826
  include Google::Apis::Core::Hashable
@@ -1147,6 +1857,20 @@ module Google
1147
1857
  # @return [Fixnum]
1148
1858
  attr_accessor :failure_count
1149
1859
 
1860
+ # Pub/Sub topic for receiving notification. If this field is set, when the
1861
+ # import is finished, a notification will be sent to specified Pub/Sub topic.
1862
+ # The message data will be JSON string of a Operation. Format of the Pub/Sub
1863
+ # topic is `projects/`project`/topics/`topic``.
1864
+ # Corresponds to the JSON property `notificationPubsubTopic`
1865
+ # @return [String]
1866
+ attr_accessor :notification_pubsub_topic
1867
+
1868
+ # Id of the request / operation. This is parroting back the requestId that was
1869
+ # passed in the request.
1870
+ # Corresponds to the JSON property `requestId`
1871
+ # @return [String]
1872
+ attr_accessor :request_id
1873
+
1150
1874
  # Count of entries that were processed successfully.
1151
1875
  # Corresponds to the JSON property `successCount`
1152
1876
  # @return [Fixnum]
@@ -1166,6 +1890,8 @@ module Google
1166
1890
  def update!(**args)
1167
1891
  @create_time = args[:create_time] if args.key?(:create_time)
1168
1892
  @failure_count = args[:failure_count] if args.key?(:failure_count)
1893
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
1894
+ @request_id = args[:request_id] if args.key?(:request_id)
1169
1895
  @success_count = args[:success_count] if args.key?(:success_count)
1170
1896
  @update_time = args[:update_time] if args.key?(:update_time)
1171
1897
  end
@@ -1185,6 +1911,30 @@ module Google
1185
1911
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductInputConfig]
1186
1912
  attr_accessor :input_config
1187
1913
 
1914
+ # Pub/Sub topic for receiving notification. If this field is set, when the
1915
+ # import is finished, a notification will be sent to specified Pub/Sub topic.
1916
+ # The message data will be JSON string of a Operation. Format of the Pub/Sub
1917
+ # topic is `projects/`project`/topics/`topic``. Only supported when
1918
+ # ImportProductsRequest.reconciliation_mode is set to `FULL`.
1919
+ # Corresponds to the JSON property `notificationPubsubTopic`
1920
+ # @return [String]
1921
+ attr_accessor :notification_pubsub_topic
1922
+
1923
+ # The mode of reconciliation between existing products and the products to be
1924
+ # imported. Defaults to ReconciliationMode.INCREMENTAL.
1925
+ # Corresponds to the JSON property `reconciliationMode`
1926
+ # @return [String]
1927
+ attr_accessor :reconciliation_mode
1928
+
1929
+ # Unique identifier provided by client, within the ancestor dataset scope.
1930
+ # Ensures idempotency and used for request deduplication. Server-generated if
1931
+ # unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-
1932
+ # 9_]+". This is returned as Operation.name in ImportMetadata. Only supported
1933
+ # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1934
+ # Corresponds to the JSON property `requestId`
1935
+ # @return [String]
1936
+ attr_accessor :request_id
1937
+
1188
1938
  # Indicates which fields in the provided imported 'products' to update. If not
1189
1939
  # set, will by default update all fields.
1190
1940
  # Corresponds to the JSON property `updateMask`
@@ -1199,6 +1949,9 @@ module Google
1199
1949
  def update!(**args)
1200
1950
  @errors_config = args[:errors_config] if args.key?(:errors_config)
1201
1951
  @input_config = args[:input_config] if args.key?(:input_config)
1952
+ @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
1953
+ @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
1954
+ @request_id = args[:request_id] if args.key?(:request_id)
1202
1955
  @update_mask = args[:update_mask] if args.key?(:update_mask)
1203
1956
  end
1204
1957
  end
@@ -1289,6 +2042,43 @@ module Google
1289
2042
  end
1290
2043
  end
1291
2044
 
2045
+ # A floating point interval.
2046
+ class GoogleCloudRetailV2betaInterval
2047
+ include Google::Apis::Core::Hashable
2048
+
2049
+ # Exclusive upper bound.
2050
+ # Corresponds to the JSON property `exclusiveMaximum`
2051
+ # @return [Float]
2052
+ attr_accessor :exclusive_maximum
2053
+
2054
+ # Exclusive lower bound.
2055
+ # Corresponds to the JSON property `exclusiveMinimum`
2056
+ # @return [Float]
2057
+ attr_accessor :exclusive_minimum
2058
+
2059
+ # Inclusive upper bound.
2060
+ # Corresponds to the JSON property `maximum`
2061
+ # @return [Float]
2062
+ attr_accessor :maximum
2063
+
2064
+ # Inclusive lower bound.
2065
+ # Corresponds to the JSON property `minimum`
2066
+ # @return [Float]
2067
+ attr_accessor :minimum
2068
+
2069
+ def initialize(**args)
2070
+ update!(**args)
2071
+ end
2072
+
2073
+ # Update properties of this object
2074
+ def update!(**args)
2075
+ @exclusive_maximum = args[:exclusive_maximum] if args.key?(:exclusive_maximum)
2076
+ @exclusive_minimum = args[:exclusive_minimum] if args.key?(:exclusive_minimum)
2077
+ @maximum = args[:maximum] if args.key?(:maximum)
2078
+ @minimum = args[:minimum] if args.key?(:minimum)
2079
+ end
2080
+ end
2081
+
1292
2082
  # Response for CatalogService.ListCatalogs method.
1293
2083
  class GoogleCloudRetailV2betaListCatalogsResponse
1294
2084
  include Google::Apis::Core::Hashable
@@ -1315,6 +2105,32 @@ module Google
1315
2105
  end
1316
2106
  end
1317
2107
 
2108
+ # Response message for ProductService.ListProducts method.
2109
+ class GoogleCloudRetailV2betaListProductsResponse
2110
+ include Google::Apis::Core::Hashable
2111
+
2112
+ # A token that can be sent as ListProductsRequest.page_token to retrieve the
2113
+ # next page. If this field is omitted, there are no subsequent pages.
2114
+ # Corresponds to the JSON property `nextPageToken`
2115
+ # @return [String]
2116
+ attr_accessor :next_page_token
2117
+
2118
+ # The Products.
2119
+ # Corresponds to the JSON property `products`
2120
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct>]
2121
+ attr_accessor :products
2122
+
2123
+ def initialize(**args)
2124
+ update!(**args)
2125
+ end
2126
+
2127
+ # Update properties of this object
2128
+ def update!(**args)
2129
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2130
+ @products = args[:products] if args.key?(:products)
2131
+ end
2132
+ end
2133
+
1318
2134
  # Request message for Predict method.
1319
2135
  class GoogleCloudRetailV2betaPredictRequest
1320
2136
  include Google::Apis::Core::Hashable
@@ -1500,7 +2316,9 @@ module Google
1500
2316
 
1501
2317
  # The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-
1502
2318
  # currency-codes.html). If this field is an unrecognizable currency code, an
1503
- # INVALID_ARGUMENT error is returned.
2319
+ # INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the
2320
+ # same Product.primary_product_id must share the same currency_code. Otherwise,
2321
+ # a FAILED_PRECONDITION error is returned.
1504
2322
  # Corresponds to the JSON property `currencyCode`
1505
2323
  # @return [String]
1506
2324
  attr_accessor :currency_code
@@ -1518,6 +2336,29 @@ module Google
1518
2336
  # @return [Float]
1519
2337
  attr_accessor :price
1520
2338
 
2339
+ # The timestamp when the price starts to be effective. This can be set as a
2340
+ # future timestamp, and the price is only used for search after
2341
+ # price_effective_time. If so, the original_price must be set and original_price
2342
+ # is used before price_effective_time. Do not set if price is always effective
2343
+ # because it will cause additional latency during search.
2344
+ # Corresponds to the JSON property `priceEffectiveTime`
2345
+ # @return [String]
2346
+ attr_accessor :price_effective_time
2347
+
2348
+ # The timestamp when the price stops to be effective. The price is used for
2349
+ # search before price_expire_time. If this field is set, the original_price must
2350
+ # be set and original_price is used after price_expire_time. Do not set if price
2351
+ # is always effective because it will cause additional latency during search.
2352
+ # Corresponds to the JSON property `priceExpireTime`
2353
+ # @return [String]
2354
+ attr_accessor :price_expire_time
2355
+
2356
+ # The price range of all variant Product having the same Product.
2357
+ # primary_product_id.
2358
+ # Corresponds to the JSON property `priceRange`
2359
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPriceInfoPriceRange]
2360
+ attr_accessor :price_range
2361
+
1521
2362
  def initialize(**args)
1522
2363
  update!(**args)
1523
2364
  end
@@ -1528,6 +2369,35 @@ module Google
1528
2369
  @currency_code = args[:currency_code] if args.key?(:currency_code)
1529
2370
  @original_price = args[:original_price] if args.key?(:original_price)
1530
2371
  @price = args[:price] if args.key?(:price)
2372
+ @price_effective_time = args[:price_effective_time] if args.key?(:price_effective_time)
2373
+ @price_expire_time = args[:price_expire_time] if args.key?(:price_expire_time)
2374
+ @price_range = args[:price_range] if args.key?(:price_range)
2375
+ end
2376
+ end
2377
+
2378
+ # The price range of all variant Product having the same Product.
2379
+ # primary_product_id.
2380
+ class GoogleCloudRetailV2betaPriceInfoPriceRange
2381
+ include Google::Apis::Core::Hashable
2382
+
2383
+ # A floating point interval.
2384
+ # Corresponds to the JSON property `originalPrice`
2385
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval]
2386
+ attr_accessor :original_price
2387
+
2388
+ # A floating point interval.
2389
+ # Corresponds to the JSON property `price`
2390
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval]
2391
+ attr_accessor :price
2392
+
2393
+ def initialize(**args)
2394
+ update!(**args)
2395
+ end
2396
+
2397
+ # Update properties of this object
2398
+ def update!(**args)
2399
+ @original_price = args[:original_price] if args.key?(:original_price)
2400
+ @price = args[:price] if args.key?(:price)
1531
2401
  end
1532
2402
  end
1533
2403
 
@@ -1546,13 +2416,19 @@ module Google
1546
2416
  # product, or age of a customer. For example: `` "vendor": `"text": ["vendor123",
1547
2417
  # "vendor456"]`, "lengths_cm": `"numbers":[2.3, 15.4]`, "heights_cm": `"numbers"
1548
2418
  # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
1549
- # INVALID_ARGUMENT error is returned: * Max entries count: 200 by default; 100
1550
- # for Type.VARIANT. * The key must be a UTF-8 encoded string with a length limit
1551
- # of 128 characters.
2419
+ # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
2420
+ # be a UTF-8 encoded string with a length limit of 128 characters. * For
2421
+ # indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
2422
+ # key0LikeThis or KEY_1_LIKE_THIS.
1552
2423
  # Corresponds to the JSON property `attributes`
1553
2424
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
1554
2425
  attr_accessor :attributes
1555
2426
 
2427
+ # An intended audience of the Product for whom it's sold.
2428
+ # Corresponds to the JSON property `audience`
2429
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAudience]
2430
+ attr_accessor :audience
2431
+
1556
2432
  # The online availability of the Product. Default to Availability.IN_STOCK.
1557
2433
  # Google Merchant Center Property [availability](https://support.google.com/
1558
2434
  # merchants/answer/6324448). Schema.org Property [Offer.availability](https://
@@ -1566,12 +2442,21 @@ module Google
1566
2442
  # @return [Fixnum]
1567
2443
  attr_accessor :available_quantity
1568
2444
 
1569
- # The timestamp when this Product becomes available for recommendation.
2445
+ # The timestamp when this Product becomes available for SearchService.Search.
1570
2446
  # Corresponds to the JSON property `availableTime`
1571
2447
  # @return [String]
1572
2448
  attr_accessor :available_time
1573
2449
 
1574
- # Product categories. This field is repeated for supporting one product
2450
+ # The brands of the product. A maximum of 30 brands are allowed. Each brand must
2451
+ # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
2452
+ # an INVALID_ARGUMENT error is returned. Google Merchant Center property [brand](
2453
+ # https://support.google.com/merchants/answer/6324351). Schema.org property [
2454
+ # Product.brand](https://schema.org/brand).
2455
+ # Corresponds to the JSON property `brands`
2456
+ # @return [Array<String>]
2457
+ attr_accessor :brands
2458
+
2459
+ # Product categories. This field is repeated for supporting one product
1575
2460
  # belonging to several parallel categories. Strongly recommended using the full
1576
2461
  # path for better search / recommendation quality. To represent full path of
1577
2462
  # category, use '>' sign to separate different hierarchies. If '>' is part of
@@ -1591,6 +2476,29 @@ module Google
1591
2476
  # @return [Array<String>]
1592
2477
  attr_accessor :categories
1593
2478
 
2479
+ # The id of the collection members when type is Type.COLLECTION. Should not set
2480
+ # it for other types. A maximum of 1000 values are allowed. Otherwise, an
2481
+ # INVALID_ARGUMENT error is return.
2482
+ # Corresponds to the JSON property `collectionMemberIds`
2483
+ # @return [Array<String>]
2484
+ attr_accessor :collection_member_ids
2485
+
2486
+ # The color information of a Product.
2487
+ # Corresponds to the JSON property `colorInfo`
2488
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaColorInfo]
2489
+ attr_accessor :color_info
2490
+
2491
+ # The condition of the product. Strongly encouraged to use the standard values: "
2492
+ # new", "refurbished", "used". A maximum of 5 values are allowed per Product.
2493
+ # Each value must be a UTF-8 encoded string with a length limit of 128
2494
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant
2495
+ # Center property [condition](https://support.google.com/merchants/answer/
2496
+ # 6324469). Schema.org property [Offer.itemCondition](https://schema.org/
2497
+ # itemCondition).
2498
+ # Corresponds to the JSON property `conditions`
2499
+ # @return [Array<String>]
2500
+ attr_accessor :conditions
2501
+
1594
2502
  # Product description. This field must be a UTF-8 encoded string with a length
1595
2503
  # limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1596
2504
  # Google Merchant Center property [description](https://support.google.com/
@@ -1600,6 +2508,35 @@ module Google
1600
2508
  # @return [String]
1601
2509
  attr_accessor :description
1602
2510
 
2511
+ # The timestamp when this product becomes unavailable for SearchService.Search.
2512
+ # If it is set, the Product is not available for SearchService.Search after
2513
+ # expire_time. However, the product can still be retrieved by ProductService.
2514
+ # GetProduct and ProductService.ListProducts. Google Merchant Center property [
2515
+ # expiration_date](https://support.google.com/merchants/answer/6324499).
2516
+ # Corresponds to the JSON property `expireTime`
2517
+ # @return [String]
2518
+ attr_accessor :expire_time
2519
+
2520
+ # Fulfillment information, such as the store IDs for in-store pickup or region
2521
+ # IDs for different shipping methods. All the elements must have distinct
2522
+ # FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned.
2523
+ # Corresponds to the JSON property `fulfillmentInfo`
2524
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaFulfillmentInfo>]
2525
+ attr_accessor :fulfillment_info
2526
+
2527
+ # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
2528
+ # encoded string with a length limit of 128 characters. Otherwise, an
2529
+ # INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
2530
+ # an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
2531
+ # https://support.google.com/merchants/answer/6324461). Schema.org property [
2532
+ # Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
2533
+ # gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
2534
+ # https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If
2535
+ # the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
2536
+ # Corresponds to the JSON property `gtin`
2537
+ # @return [String]
2538
+ attr_accessor :gtin
2539
+
1603
2540
  # Immutable. Product identifier, which is the final component of name. For
1604
2541
  # example, this field is "id_1", if name is `projects/*/locations/global/
1605
2542
  # catalogs/default_catalog/branches/default_branch/products/id_1`. This field
@@ -1619,13 +2556,42 @@ module Google
1619
2556
  # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImage>]
1620
2557
  attr_accessor :images
1621
2558
 
2559
+ # Language of the title/description and other string attributes. Use language
2560
+ # tags defined by BCP 47. For product prediction, this field is ignored and the
2561
+ # model automatically detects the text language. The Product can include text in
2562
+ # different languages, but duplicating Products to provide text in multiple
2563
+ # languages can result in degraded model performance. For product search this
2564
+ # field is in use. It defaults to "en-US" if unset.
2565
+ # Corresponds to the JSON property `languageCode`
2566
+ # @return [String]
2567
+ attr_accessor :language_code
2568
+
2569
+ # The material of the product. For example, "leather", "wooden". A maximum of 20
2570
+ # values are allowed. Each value must be a UTF-8 encoded string with a length
2571
+ # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2572
+ # Google Merchant Center property [material](https://support.google.com/
2573
+ # merchants/answer/6324410). Schema.org property [Product.material](https://
2574
+ # schema.org/material).
2575
+ # Corresponds to the JSON property `materials`
2576
+ # @return [Array<String>]
2577
+ attr_accessor :materials
2578
+
1622
2579
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1623
2580
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
1624
- # The branch ID must be "default_branch".
1625
2581
  # Corresponds to the JSON property `name`
1626
2582
  # @return [String]
1627
2583
  attr_accessor :name
1628
2584
 
2585
+ # The pattern or graphic print of the product. For example, "striped", "polka
2586
+ # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
2587
+ # must be a UTF-8 encoded string with a length limit of 128 characters.
2588
+ # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
2589
+ # property [pattern](https://support.google.com/merchants/answer/6324483).
2590
+ # Schema.org property [Product.pattern](https://schema.org/pattern).
2591
+ # Corresponds to the JSON property `patterns`
2592
+ # @return [Array<String>]
2593
+ attr_accessor :patterns
2594
+
1629
2595
  # The price information of a Product.
1630
2596
  # Corresponds to the JSON property `priceInfo`
1631
2597
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPriceInfo]
@@ -1644,6 +2610,58 @@ module Google
1644
2610
  # @return [String]
1645
2611
  attr_accessor :primary_product_id
1646
2612
 
2613
+ # The promotions applied to the product. A maximum of 10 values are allowed per
2614
+ # Product.
2615
+ # Corresponds to the JSON property `promotions`
2616
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPromotion>]
2617
+ attr_accessor :promotions
2618
+
2619
+ # The timestamp when the product is published by the retailer for the first time,
2620
+ # which indicates the freshness of the products. Note that this field is
2621
+ # different from available_time, given it purely describes product freshness
2622
+ # regardless of when it is available on search and recommendation.
2623
+ # Corresponds to the JSON property `publishTime`
2624
+ # @return [String]
2625
+ attr_accessor :publish_time
2626
+
2627
+ # The rating of a Product.
2628
+ # Corresponds to the JSON property `rating`
2629
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRating]
2630
+ attr_accessor :rating
2631
+
2632
+ # Indicates which fields in the Products are returned in SearchResponse.
2633
+ # Supported fields for all types: * audience * availability * brands *
2634
+ # color_info * conditions * gtin * materials * name * patterns * price_info *
2635
+ # rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.
2636
+ # COLLECTION: * categories * description * images Supported fields only for Type.
2637
+ # VARIANT: * Only the first image in images To mark attributes as retrievable,
2638
+ # include paths of the form "attributes.key" where "key" is the key of a custom
2639
+ # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
2640
+ # the following fields are always returned in SearchResponse by default: * name
2641
+ # For Type.VARIANT, the following fields are always returned in by default: *
2642
+ # name * color_info Maximum number of paths is 30. Otherwise, an
2643
+ # INVALID_ARGUMENT error is returned. Note: Returning more fields in
2644
+ # SearchResponse may increase response payload size and serving latency.
2645
+ # Corresponds to the JSON property `retrievableFields`
2646
+ # @return [String]
2647
+ attr_accessor :retrievable_fields
2648
+
2649
+ # The size of the product. To represent different size systems or size types,
2650
+ # consider using this format: [[[size_system:]size_type:]size_value]. For
2651
+ # example, in "US:MENS:M", "US" represents size system; "MENS" represents size
2652
+ # type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS"
2653
+ # represents size type; "27" represents size value. In "32 inches", both size
2654
+ # system and size type are empty, while size value is "32 inches". A maximum of
2655
+ # 20 values are allowed per Product. Each value must be a UTF-8 encoded string
2656
+ # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
2657
+ # returned. Google Merchant Center property [size](https://support.google.com/
2658
+ # merchants/answer/6324492), [size_type](https://support.google.com/merchants/
2659
+ # answer/6324497) and [size_system](https://support.google.com/merchants/answer/
2660
+ # 6324502). Schema.org property [Product.size](https://schema.org/size).
2661
+ # Corresponds to the JSON property `sizes`
2662
+ # @return [Array<String>]
2663
+ attr_accessor :sizes
2664
+
1647
2665
  # Custom tags associated with the product. At most 250 values are allowed per
1648
2666
  # Product. This value must be a UTF-8 encoded string with a length limit of 1,
1649
2667
  # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
@@ -1663,6 +2681,16 @@ module Google
1663
2681
  # @return [String]
1664
2682
  attr_accessor :title
1665
2683
 
2684
+ # Input only. The TTL (time to live) of the product. If it is set, expire_time
2685
+ # is set as current timestamp plus ttl. The derived expire_time is returned in
2686
+ # the output and ttl is left blank when retrieving the Product. If it is set,
2687
+ # the product is not available for SearchService.Search after current timestamp
2688
+ # plus ttl. However, the product can still be retrieved by ProductService.
2689
+ # GetProduct and ProductService.ListProducts.
2690
+ # Corresponds to the JSON property `ttl`
2691
+ # @return [String]
2692
+ attr_accessor :ttl
2693
+
1666
2694
  # Immutable. The type of the product. Default to Catalog.product_level_config.
1667
2695
  # ingestion_product_type if unset.
1668
2696
  # Corresponds to the JSON property `type`
@@ -1680,6 +2708,15 @@ module Google
1680
2708
  # @return [String]
1681
2709
  attr_accessor :uri
1682
2710
 
2711
+ # Output only. Product variants grouped together on primary product which share
2712
+ # similar product attributes. It's automatically grouped by primary_product_id
2713
+ # for all the product variants. Only populated for Type.PRIMARY Products. Note:
2714
+ # This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field
2715
+ # in API requests.
2716
+ # Corresponds to the JSON property `variants`
2717
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct>]
2718
+ attr_accessor :variants
2719
+
1683
2720
  def initialize(**args)
1684
2721
  update!(**args)
1685
2722
  end
@@ -1687,20 +2724,38 @@ module Google
1687
2724
  # Update properties of this object
1688
2725
  def update!(**args)
1689
2726
  @attributes = args[:attributes] if args.key?(:attributes)
2727
+ @audience = args[:audience] if args.key?(:audience)
1690
2728
  @availability = args[:availability] if args.key?(:availability)
1691
2729
  @available_quantity = args[:available_quantity] if args.key?(:available_quantity)
1692
2730
  @available_time = args[:available_time] if args.key?(:available_time)
2731
+ @brands = args[:brands] if args.key?(:brands)
1693
2732
  @categories = args[:categories] if args.key?(:categories)
2733
+ @collection_member_ids = args[:collection_member_ids] if args.key?(:collection_member_ids)
2734
+ @color_info = args[:color_info] if args.key?(:color_info)
2735
+ @conditions = args[:conditions] if args.key?(:conditions)
1694
2736
  @description = args[:description] if args.key?(:description)
2737
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
2738
+ @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
2739
+ @gtin = args[:gtin] if args.key?(:gtin)
1695
2740
  @id = args[:id] if args.key?(:id)
1696
2741
  @images = args[:images] if args.key?(:images)
2742
+ @language_code = args[:language_code] if args.key?(:language_code)
2743
+ @materials = args[:materials] if args.key?(:materials)
1697
2744
  @name = args[:name] if args.key?(:name)
2745
+ @patterns = args[:patterns] if args.key?(:patterns)
1698
2746
  @price_info = args[:price_info] if args.key?(:price_info)
1699
2747
  @primary_product_id = args[:primary_product_id] if args.key?(:primary_product_id)
2748
+ @promotions = args[:promotions] if args.key?(:promotions)
2749
+ @publish_time = args[:publish_time] if args.key?(:publish_time)
2750
+ @rating = args[:rating] if args.key?(:rating)
2751
+ @retrievable_fields = args[:retrievable_fields] if args.key?(:retrievable_fields)
2752
+ @sizes = args[:sizes] if args.key?(:sizes)
1700
2753
  @tags = args[:tags] if args.key?(:tags)
1701
2754
  @title = args[:title] if args.key?(:title)
2755
+ @ttl = args[:ttl] if args.key?(:ttl)
1702
2756
  @type = args[:type] if args.key?(:type)
1703
2757
  @uri = args[:uri] if args.key?(:uri)
2758
+ @variants = args[:variants] if args.key?(:variants)
1704
2759
  end
1705
2760
  end
1706
2761
 
@@ -1828,6 +2883,29 @@ module Google
1828
2883
  end
1829
2884
  end
1830
2885
 
2886
+ # Promotion information.
2887
+ class GoogleCloudRetailV2betaPromotion
2888
+ include Google::Apis::Core::Hashable
2889
+
2890
+ # ID of the promotion. For example, "free gift". The value value must be a UTF-8
2891
+ # encoded string with a length limit of 128 characters, and match the pattern: a-
2892
+ # zA-Z*. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
2893
+ # INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
2894
+ # (https://support.google.com/merchants/answer/7050148).
2895
+ # Corresponds to the JSON property `promotionId`
2896
+ # @return [String]
2897
+ attr_accessor :promotion_id
2898
+
2899
+ def initialize(**args)
2900
+ update!(**args)
2901
+ end
2902
+
2903
+ # Update properties of this object
2904
+ def update!(**args)
2905
+ @promotion_id = args[:promotion_id] if args.key?(:promotion_id)
2906
+ end
2907
+ end
2908
+
1831
2909
  # A transaction represents the entire purchase transaction.
1832
2910
  class GoogleCloudRetailV2betaPurchaseTransaction
1833
2911
  include Google::Apis::Core::Hashable
@@ -1948,6 +3026,44 @@ module Google
1948
3026
  end
1949
3027
  end
1950
3028
 
3029
+ # The rating of a Product.
3030
+ class GoogleCloudRetailV2betaRating
3031
+ include Google::Apis::Core::Hashable
3032
+
3033
+ # The average rating of the Product. The rating is scaled at 1-5. Otherwise, an
3034
+ # INVALID_ARGUMENT error is returned.
3035
+ # Corresponds to the JSON property `averageRating`
3036
+ # @return [Float]
3037
+ attr_accessor :average_rating
3038
+
3039
+ # The total number of ratings. This value is independent of the value of
3040
+ # rating_histogram. This value must be nonnegative. Otherwise, an
3041
+ # INVALID_ARGUMENT error is returned.
3042
+ # Corresponds to the JSON property `ratingCount`
3043
+ # @return [Fixnum]
3044
+ attr_accessor :rating_count
3045
+
3046
+ # List of rating counts per rating value (index = rating - 1). The list is empty
3047
+ # if there is no rating. If the list is non-empty, its size is always 5.
3048
+ # Otherwise, an INVALID_ARGUMENT error is returned. For example, [41, 14, 13, 47,
3049
+ # 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2
3050
+ # star, and so on.
3051
+ # Corresponds to the JSON property `ratingHistogram`
3052
+ # @return [Array<Fixnum>]
3053
+ attr_accessor :rating_histogram
3054
+
3055
+ def initialize(**args)
3056
+ update!(**args)
3057
+ end
3058
+
3059
+ # Update properties of this object
3060
+ def update!(**args)
3061
+ @average_rating = args[:average_rating] if args.key?(:average_rating)
3062
+ @rating_count = args[:rating_count] if args.key?(:rating_count)
3063
+ @rating_histogram = args[:rating_histogram] if args.key?(:rating_histogram)
3064
+ end
3065
+ end
3066
+
1951
3067
  # Metadata for RejoinUserEvents method.
1952
3068
  class GoogleCloudRetailV2betaRejoinUserEventsMetadata
1953
3069
  include Google::Apis::Core::Hashable
@@ -2002,6 +3118,849 @@ module Google
2002
3118
  end
2003
3119
  end
2004
3120
 
3121
+ # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
3122
+ # Currently empty because there is no meaningful metadata populated from the
3123
+ # RemoveFulfillmentPlaces method.
3124
+ class GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata
3125
+ include Google::Apis::Core::Hashable
3126
+
3127
+ def initialize(**args)
3128
+ update!(**args)
3129
+ end
3130
+
3131
+ # Update properties of this object
3132
+ def update!(**args)
3133
+ end
3134
+ end
3135
+
3136
+ # Request message for RemoveFulfillmentPlaces method.
3137
+ class GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest
3138
+ include Google::Apis::Core::Hashable
3139
+
3140
+ # If set to true, and the Product is not found, the fulfillment information will
3141
+ # still be processed and retained for at most 1 day and processed once the
3142
+ # Product is created. If set to false, an INVALID_ARGUMENT error is returned if
3143
+ # the Product is not found.
3144
+ # Corresponds to the JSON property `allowMissing`
3145
+ # @return [Boolean]
3146
+ attr_accessor :allow_missing
3147
+ alias_method :allow_missing?, :allow_missing
3148
+
3149
+ # Required. The IDs for this type, such as the store IDs for "pickup-in-store"
3150
+ # or the region IDs for "same-day-delivery", to be removed for this type. At
3151
+ # least 1 value is required, and a maximum of 2000 values are allowed. Each
3152
+ # value must be a string with a length limit of 10 characters, matching the
3153
+ # pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
3154
+ # INVALID_ARGUMENT error is returned.
3155
+ # Corresponds to the JSON property `placeIds`
3156
+ # @return [Array<String>]
3157
+ attr_accessor :place_ids
3158
+
3159
+ # The time when the fulfillment updates are issued, used to prevent out-of-order
3160
+ # updates on fulfillment information. If not provided, the internal system time
3161
+ # will be used.
3162
+ # Corresponds to the JSON property `removeTime`
3163
+ # @return [String]
3164
+ attr_accessor :remove_time
3165
+
3166
+ # Required. The fulfillment type, including commonly used types (such as pickup
3167
+ # in store and same day delivery), and custom types. Supported values: * "pickup-
3168
+ # in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "
3169
+ # custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-
3170
+ # type-5" If this field is set to an invalid value other than these, an
3171
+ # INVALID_ARGUMENT error is returned. This field directly corresponds to Product.
3172
+ # fulfillment_info.type.
3173
+ # Corresponds to the JSON property `type`
3174
+ # @return [String]
3175
+ attr_accessor :type
3176
+
3177
+ def initialize(**args)
3178
+ update!(**args)
3179
+ end
3180
+
3181
+ # Update properties of this object
3182
+ def update!(**args)
3183
+ @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
3184
+ @place_ids = args[:place_ids] if args.key?(:place_ids)
3185
+ @remove_time = args[:remove_time] if args.key?(:remove_time)
3186
+ @type = args[:type] if args.key?(:type)
3187
+ end
3188
+ end
3189
+
3190
+ # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
3191
+ # is no meaningful response populated from the RemoveFulfillmentPlaces method.
3192
+ class GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse
3193
+ include Google::Apis::Core::Hashable
3194
+
3195
+ def initialize(**args)
3196
+ update!(**args)
3197
+ end
3198
+
3199
+ # Update properties of this object
3200
+ def update!(**args)
3201
+ end
3202
+ end
3203
+
3204
+ # Request message for SearchService.Search method.
3205
+ class GoogleCloudRetailV2betaSearchRequest
3206
+ include Google::Apis::Core::Hashable
3207
+
3208
+ # Boost specification to boost certain items.
3209
+ # Corresponds to the JSON property `boostSpec`
3210
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpec]
3211
+ attr_accessor :boost_spec
3212
+
3213
+ # The branch resource name, such as `projects/*/locations/global/catalogs/
3214
+ # default_catalog/branches/0`. Use "default_branch" as the branch ID or leave
3215
+ # this field empty, to search products under the default branch.
3216
+ # Corresponds to the JSON property `branch`
3217
+ # @return [String]
3218
+ attr_accessor :branch
3219
+
3220
+ # The filter applied to every search request when quality improvement such as
3221
+ # query expansion is needed. For example, if a query does not have enough
3222
+ # results, an expanded query with SearchRequest.canonical_filter will be
3223
+ # returned as a supplement of the original query. This field is strongly
3224
+ # recommended to achieve high search quality. See SearchRequest.filter for more
3225
+ # details about filter syntax.
3226
+ # Corresponds to the JSON property `canonicalFilter`
3227
+ # @return [String]
3228
+ attr_accessor :canonical_filter
3229
+
3230
+ # The specifications of dynamically generated facets.
3231
+ # Corresponds to the JSON property `dynamicFacetSpec`
3232
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec]
3233
+ attr_accessor :dynamic_facet_spec
3234
+
3235
+ # Facet specifications for faceted search. If empty, no facets are returned. A
3236
+ # maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is
3237
+ # returned.
3238
+ # Corresponds to the JSON property `facetSpecs`
3239
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec>]
3240
+ attr_accessor :facet_specs
3241
+
3242
+ # The filter syntax consists of an expression language for constructing a
3243
+ # predicate from one or more fields of the products being filtered. Filter
3244
+ # expression is case-sensitive. See more details at this [user guide](https://
3245
+ # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
3246
+ # unrecognizable, an INVALID_ARGUMENT is returned.
3247
+ # Corresponds to the JSON property `filter`
3248
+ # @return [String]
3249
+ attr_accessor :filter
3250
+
3251
+ # A 0-indexed integer that specifies the current offset (that is, starting
3252
+ # result location, amongst the Products deemed by the API as relevant) in search
3253
+ # results. This field is only considered if page_token is unset. If this field
3254
+ # is negative, an INVALID_ARGUMENT is returned.
3255
+ # Corresponds to the JSON property `offset`
3256
+ # @return [Fixnum]
3257
+ attr_accessor :offset
3258
+
3259
+ # The order in which products are returned. Products can be ordered by a field
3260
+ # in an Product object. Leave it unset if ordered by relevance. OrderBy
3261
+ # expression is case-sensitive. See more details at this [user guide](https://
3262
+ # cloud.google.com/retail/docs/filter-and-order#order). If this field is
3263
+ # unrecognizable, an INVALID_ARGUMENT is returned.
3264
+ # Corresponds to the JSON property `orderBy`
3265
+ # @return [String]
3266
+ attr_accessor :order_by
3267
+
3268
+ # The categories associated with a category page. Required for category
3269
+ # navigation queries to achieve good search quality. The format should be the
3270
+ # same as UserEvent.page_categories; To represent full path of category, use '>'
3271
+ # sign to separate different hierarchies. If '>' is part of the category name,
3272
+ # please replace it with other character(s). Category pages include special
3273
+ # pages such as sales or promotions. For instance, a special sale page may have
3274
+ # the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
3275
+ # Corresponds to the JSON property `pageCategories`
3276
+ # @return [Array<String>]
3277
+ attr_accessor :page_categories
3278
+
3279
+ # Maximum number of Products to return. If unspecified, defaults to a reasonable
3280
+ # value. The maximum allowed value is 120. Values above 120 will be coerced to
3281
+ # 120. If this field is negative, an INVALID_ARGUMENT is returned.
3282
+ # Corresponds to the JSON property `pageSize`
3283
+ # @return [Fixnum]
3284
+ attr_accessor :page_size
3285
+
3286
+ # A page token SearchResponse.next_page_token, received from a previous
3287
+ # SearchService.Search call. Provide this to retrieve the subsequent page. When
3288
+ # paginating, all other parameters provided to SearchService.Search must match
3289
+ # the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is
3290
+ # returned.
3291
+ # Corresponds to the JSON property `pageToken`
3292
+ # @return [String]
3293
+ attr_accessor :page_token
3294
+
3295
+ # Raw search query.
3296
+ # Corresponds to the JSON property `query`
3297
+ # @return [String]
3298
+ attr_accessor :query
3299
+
3300
+ # Specification to determine under which conditions query expansion should occur.
3301
+ # Corresponds to the JSON property `queryExpansionSpec`
3302
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec]
3303
+ attr_accessor :query_expansion_spec
3304
+
3305
+ # Information of an end user.
3306
+ # Corresponds to the JSON property `userInfo`
3307
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo]
3308
+ attr_accessor :user_info
3309
+
3310
+ # The keys to fetch and rollup the matching variant Products attributes. The
3311
+ # attributes from all the matching variant Products are merged and de-duplicated.
3312
+ # Notice that rollup variant Products attributes will lead to extra query
3313
+ # latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
3314
+ # and a fulfillment ID must be provided in the format of "fulfillmentType.
3315
+ # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
3316
+ # fulfillment type and "store123" is the store ID. Supported keys are: *
3317
+ # colorFamilies * price * originalPrice * discount * attributes.key, where key
3318
+ # is any key in the Product.attributes map. * pickupInStore.id, where id is any
3319
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
3320
+ # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
3321
+ # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
3322
+ # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
3323
+ # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
3324
+ # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
3325
+ # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
3326
+ # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
3327
+ # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
3328
+ # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
3329
+ # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
3330
+ # customFulfillment5.id, where id is any FulfillmentInfo.place_ids for
3331
+ # FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value
3332
+ # other than these, an INVALID_ARGUMENT error is returned.
3333
+ # Corresponds to the JSON property `variantRollupKeys`
3334
+ # @return [Array<String>]
3335
+ attr_accessor :variant_rollup_keys
3336
+
3337
+ # Required. A unique identifier for tracking visitors. For example, this could
3338
+ # be implemented with an HTTP cookie, which should be able to uniquely identify
3339
+ # a visitor on a single device. This unique identifier should not change if the
3340
+ # visitor logs in or out of the website. The field must be a UTF-8 encoded
3341
+ # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
3342
+ # error is returned.
3343
+ # Corresponds to the JSON property `visitorId`
3344
+ # @return [String]
3345
+ attr_accessor :visitor_id
3346
+
3347
+ def initialize(**args)
3348
+ update!(**args)
3349
+ end
3350
+
3351
+ # Update properties of this object
3352
+ def update!(**args)
3353
+ @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
3354
+ @branch = args[:branch] if args.key?(:branch)
3355
+ @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
3356
+ @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
3357
+ @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
3358
+ @filter = args[:filter] if args.key?(:filter)
3359
+ @offset = args[:offset] if args.key?(:offset)
3360
+ @order_by = args[:order_by] if args.key?(:order_by)
3361
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
3362
+ @page_size = args[:page_size] if args.key?(:page_size)
3363
+ @page_token = args[:page_token] if args.key?(:page_token)
3364
+ @query = args[:query] if args.key?(:query)
3365
+ @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
3366
+ @user_info = args[:user_info] if args.key?(:user_info)
3367
+ @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
3368
+ @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
3369
+ end
3370
+ end
3371
+
3372
+ # Boost specification to boost certain items.
3373
+ class GoogleCloudRetailV2betaSearchRequestBoostSpec
3374
+ include Google::Apis::Core::Hashable
3375
+
3376
+ # Condition boost specifications. If a product matches multiple conditions in
3377
+ # the specifictions, boost scores from these specifications are all applied and
3378
+ # combined in a non-linear way. Maximum number of specifications is 10.
3379
+ # Corresponds to the JSON property `conditionBoostSpecs`
3380
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec>]
3381
+ attr_accessor :condition_boost_specs
3382
+
3383
+ def initialize(**args)
3384
+ update!(**args)
3385
+ end
3386
+
3387
+ # Update properties of this object
3388
+ def update!(**args)
3389
+ @condition_boost_specs = args[:condition_boost_specs] if args.key?(:condition_boost_specs)
3390
+ end
3391
+ end
3392
+
3393
+ # Boost applies to products which match a condition.
3394
+ class GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec
3395
+ include Google::Apis::Core::Hashable
3396
+
3397
+ # Strength of the condition boost, which should be in [-1, 1]. Negative boost
3398
+ # means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion.
3399
+ # However, it does not necessarily mean that the boosted item will be the top
3400
+ # result at all times, nor that other items will be excluded. Results could
3401
+ # still be shown even when none of them matches the condition. And results that
3402
+ # are significantly more relevant to the search query can still trump your
3403
+ # heavily favored but irrelevant items. Setting to -1.0 gives the item a big
3404
+ # demotion. However, results that are deeply relevant might still be shown. The
3405
+ # item will have an upstream battle to get a fairly high ranking, but it is not
3406
+ # blocked out completely. Setting to 0.0 means no boost applied. The boosting
3407
+ # condition is ignored.
3408
+ # Corresponds to the JSON property `boost`
3409
+ # @return [Float]
3410
+ attr_accessor :boost
3411
+
3412
+ # An expression which specifies a boost condition. The syntax and supported
3413
+ # fields are the same as a filter expression. See SearchRequest.filter for
3414
+ # detail syntax and limitations. Examples: * To boost products with product ID "
3415
+ # product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "
3416
+ # product_2")) AND (colorFamilies: ANY("Red","Blue"))
3417
+ # Corresponds to the JSON property `condition`
3418
+ # @return [String]
3419
+ attr_accessor :condition
3420
+
3421
+ def initialize(**args)
3422
+ update!(**args)
3423
+ end
3424
+
3425
+ # Update properties of this object
3426
+ def update!(**args)
3427
+ @boost = args[:boost] if args.key?(:boost)
3428
+ @condition = args[:condition] if args.key?(:condition)
3429
+ end
3430
+ end
3431
+
3432
+ # The specifications of dynamically generated facets.
3433
+ class GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec
3434
+ include Google::Apis::Core::Hashable
3435
+
3436
+ # Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
3437
+ # Corresponds to the JSON property `mode`
3438
+ # @return [String]
3439
+ attr_accessor :mode
3440
+
3441
+ def initialize(**args)
3442
+ update!(**args)
3443
+ end
3444
+
3445
+ # Update properties of this object
3446
+ def update!(**args)
3447
+ @mode = args[:mode] if args.key?(:mode)
3448
+ end
3449
+ end
3450
+
3451
+ # A facet specification to perform faceted search.
3452
+ class GoogleCloudRetailV2betaSearchRequestFacetSpec
3453
+ include Google::Apis::Core::Hashable
3454
+
3455
+ # Enables dynamic position for this facet. If set to true, the position of this
3456
+ # facet among all facets in the response is determined by Google Retail Search.
3457
+ # It will be ordered together with dynamic facets if dynamic facets is enabled.
3458
+ # If set to false, the position of this facet in the response will be the same
3459
+ # as in the request, and it will be ranked before the facets with dynamic
3460
+ # position enable and all dynamic facets. For example, you may always want to
3461
+ # have rating facet returned in the response, but it's not necessarily to always
3462
+ # display the rating facet at the top. In that case, you can set
3463
+ # enable_dynamic_position to true so that the position of rating facet in
3464
+ # response will be determined by Google Retail Search. Another example, assuming
3465
+ # you have the following facets in the request: * "rating",
3466
+ # enable_dynamic_position = true * "price", enable_dynamic_position = false * "
3467
+ # brands", enable_dynamic_position = false And also you have a dynamic facets
3468
+ # enable, which will generate a facet 'gender'. Then the final order of the
3469
+ # facets in the response can be ("price", "brands", "rating", "gender") or ("
3470
+ # price", "brands", "gender", "rating") depends on how Google Retail Search
3471
+ # orders "gender" and "rating" facets. However, notice that "price" and "brands"
3472
+ # will always be ranked at 1st and 2nd position since their
3473
+ # enable_dynamic_position are false.
3474
+ # Corresponds to the JSON property `enableDynamicPosition`
3475
+ # @return [Boolean]
3476
+ attr_accessor :enable_dynamic_position
3477
+ alias_method :enable_dynamic_position?, :enable_dynamic_position
3478
+
3479
+ # List of keys to exclude when faceting. By default, FacetKey.key is not
3480
+ # excluded from the filter unless it is listed in this field. For example,
3481
+ # suppose there are 100 products with color facet "Red" and 200 products with
3482
+ # color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")"
3483
+ # and have "colorFamilies" as FacetKey.key will by default return the "Red" with
3484
+ # count 100. If this field contains "colorFamilies", then the query returns both
3485
+ # the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies"
3486
+ # key is now excluded from the filter. A maximum of 100 values are allowed.
3487
+ # Otherwise, an INVALID_ARGUMENT error is returned.
3488
+ # Corresponds to the JSON property `excludedFilterKeys`
3489
+ # @return [Array<String>]
3490
+ attr_accessor :excluded_filter_keys
3491
+
3492
+ # Specifies how a facet is computed.
3493
+ # Corresponds to the JSON property `facetKey`
3494
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey]
3495
+ attr_accessor :facet_key
3496
+
3497
+ # Maximum of facet values that should be returned for this facet. If unspecified,
3498
+ # defaults to 20. The maximum allowed value is 300. Values above 300 will be
3499
+ # coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
3500
+ # Corresponds to the JSON property `limit`
3501
+ # @return [Fixnum]
3502
+ attr_accessor :limit
3503
+
3504
+ def initialize(**args)
3505
+ update!(**args)
3506
+ end
3507
+
3508
+ # Update properties of this object
3509
+ def update!(**args)
3510
+ @enable_dynamic_position = args[:enable_dynamic_position] if args.key?(:enable_dynamic_position)
3511
+ @excluded_filter_keys = args[:excluded_filter_keys] if args.key?(:excluded_filter_keys)
3512
+ @facet_key = args[:facet_key] if args.key?(:facet_key)
3513
+ @limit = args[:limit] if args.key?(:limit)
3514
+ end
3515
+ end
3516
+
3517
+ # Specifies how a facet is computed.
3518
+ class GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey
3519
+ include Google::Apis::Core::Hashable
3520
+
3521
+ # Only get facet values that contains the given strings. For example, suppose "
3522
+ # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
3523
+ # If set "contains" to "Shoe", the "categories" facet will give only "Women >
3524
+ # Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
3525
+ # Corresponds to the JSON property `contains`
3526
+ # @return [Array<String>]
3527
+ attr_accessor :contains
3528
+
3529
+ # Set only if values should be bucketized into intervals. Must be set for facets
3530
+ # with numerical values. Must not be set for facet with text values. Maximum
3531
+ # number of intervals is 30.
3532
+ # Corresponds to the JSON property `intervals`
3533
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval>]
3534
+ attr_accessor :intervals
3535
+
3536
+ # Required. Supported textual and numerical facet keys in Product object, over
3537
+ # which the facet values are computed. Facet key is case-sensitive. Allowed
3538
+ # facet keys when FacetKey.query is not specified: * textual_field = * "brands" *
3539
+ # "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "
3540
+ # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
3541
+ # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
3542
+ # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
3543
+ # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
3544
+ # discount" * "rating" * "ratingCount" * "attributes.key"
3545
+ # Corresponds to the JSON property `key`
3546
+ # @return [String]
3547
+ attr_accessor :key
3548
+
3549
+ # The order in which Facet.values are returned. Allowed values are: * "count
3550
+ # desc", which means order by Facet.FacetValue.count descending. * "value desc",
3551
+ # which means order by Facet.FacetValue.value descending. Only applies to
3552
+ # textual facets. If not set, textual values are sorted in [natural order](https:
3553
+ # //en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in
3554
+ # the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are
3555
+ # sorted in the order given by FacetSpec.FacetKey.restricted_values.
3556
+ # Corresponds to the JSON property `orderBy`
3557
+ # @return [String]
3558
+ attr_accessor :order_by
3559
+
3560
+ # Only get facet values that start with the given string prefix. For example,
3561
+ # suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men
3562
+ # > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "
3563
+ # Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum
3564
+ # is 10.
3565
+ # Corresponds to the JSON property `prefixes`
3566
+ # @return [Array<String>]
3567
+ attr_accessor :prefixes
3568
+
3569
+ # The query that is used to compute facet for the given facet key. When provided,
3570
+ # it will override the default behavior of facet computation. The query syntax
3571
+ # is the same as a filter expression. See SearchRequest.filter for detail syntax
3572
+ # and limitations. Notice that there is no limitation on FacetKey.key when query
3573
+ # is specified. In the response, FacetValue.value will be always "1" and
3574
+ # FacetValue.count will be the number of results that matches the query. For
3575
+ # example, you can set a customized facet for "shipToStore", where FacetKey.key
3576
+ # is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"
3577
+ # IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will count the
3578
+ # products that are both in stock and ship to store "123".
3579
+ # Corresponds to the JSON property `query`
3580
+ # @return [String]
3581
+ attr_accessor :query
3582
+
3583
+ # Only get facet for the given restricted values. For example, when using "
3584
+ # pickupInStore" as key and set restricted values to ["store123", "store456"],
3585
+ # only facets for "store123" and "store456" are returned. Only supported on
3586
+ # textual fields and fulfillments. Maximum is 20. Must be set for the
3587
+ # fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery *
3588
+ # nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3
3589
+ # * customFulfillment4 * customFulfillment5
3590
+ # Corresponds to the JSON property `restrictedValues`
3591
+ # @return [Array<String>]
3592
+ attr_accessor :restricted_values
3593
+
3594
+ def initialize(**args)
3595
+ update!(**args)
3596
+ end
3597
+
3598
+ # Update properties of this object
3599
+ def update!(**args)
3600
+ @contains = args[:contains] if args.key?(:contains)
3601
+ @intervals = args[:intervals] if args.key?(:intervals)
3602
+ @key = args[:key] if args.key?(:key)
3603
+ @order_by = args[:order_by] if args.key?(:order_by)
3604
+ @prefixes = args[:prefixes] if args.key?(:prefixes)
3605
+ @query = args[:query] if args.key?(:query)
3606
+ @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
3607
+ end
3608
+ end
3609
+
3610
+ # Specification to determine under which conditions query expansion should occur.
3611
+ class GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec
3612
+ include Google::Apis::Core::Hashable
3613
+
3614
+ # The condition under which query expansion should occur. Default to Condition.
3615
+ # DISABLED.
3616
+ # Corresponds to the JSON property `condition`
3617
+ # @return [String]
3618
+ attr_accessor :condition
3619
+
3620
+ # Whether to pin unexpanded results. If this field is set to true, unexpanded
3621
+ # products are always at the top of the search results, followed by the expanded
3622
+ # results.
3623
+ # Corresponds to the JSON property `pinUnexpandedResults`
3624
+ # @return [Boolean]
3625
+ attr_accessor :pin_unexpanded_results
3626
+ alias_method :pin_unexpanded_results?, :pin_unexpanded_results
3627
+
3628
+ def initialize(**args)
3629
+ update!(**args)
3630
+ end
3631
+
3632
+ # Update properties of this object
3633
+ def update!(**args)
3634
+ @condition = args[:condition] if args.key?(:condition)
3635
+ @pin_unexpanded_results = args[:pin_unexpanded_results] if args.key?(:pin_unexpanded_results)
3636
+ end
3637
+ end
3638
+
3639
+ # Response message for SearchService.Search method.
3640
+ class GoogleCloudRetailV2betaSearchResponse
3641
+ include Google::Apis::Core::Hashable
3642
+
3643
+ # A unique search token. This should be included in the UserEvent logs resulting
3644
+ # from this search, which enables accurate attribution of search model
3645
+ # performance.
3646
+ # Corresponds to the JSON property `attributionToken`
3647
+ # @return [String]
3648
+ attr_accessor :attribution_token
3649
+
3650
+ # If spell correction applies, the corrected query. Otherwise, empty.
3651
+ # Corresponds to the JSON property `correctedQuery`
3652
+ # @return [String]
3653
+ attr_accessor :corrected_query
3654
+
3655
+ # Results of facets requested by user.
3656
+ # Corresponds to the JSON property `facets`
3657
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet>]
3658
+ attr_accessor :facets
3659
+
3660
+ # A token that can be sent as SearchRequest.page_token to retrieve the next page.
3661
+ # If this field is omitted, there are no subsequent pages.
3662
+ # Corresponds to the JSON property `nextPageToken`
3663
+ # @return [String]
3664
+ attr_accessor :next_page_token
3665
+
3666
+ # Information describing query expansion including whether expansion has
3667
+ # occurred.
3668
+ # Corresponds to the JSON property `queryExpansionInfo`
3669
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseQueryExpansionInfo]
3670
+ attr_accessor :query_expansion_info
3671
+
3672
+ # The URI of a customer-defined redirect page. If redirect action is triggered,
3673
+ # no search will be performed, and only redirect_uri and attribution_token will
3674
+ # be set in the response.
3675
+ # Corresponds to the JSON property `redirectUri`
3676
+ # @return [String]
3677
+ attr_accessor :redirect_uri
3678
+
3679
+ # A list of matched items. The order represents the ranking.
3680
+ # Corresponds to the JSON property `results`
3681
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseSearchResult>]
3682
+ attr_accessor :results
3683
+
3684
+ # The estimated total count of matched items irrespective of pagination. The
3685
+ # count of results returned by pagination may be less than the total_size that
3686
+ # matches.
3687
+ # Corresponds to the JSON property `totalSize`
3688
+ # @return [Fixnum]
3689
+ attr_accessor :total_size
3690
+
3691
+ def initialize(**args)
3692
+ update!(**args)
3693
+ end
3694
+
3695
+ # Update properties of this object
3696
+ def update!(**args)
3697
+ @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
3698
+ @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
3699
+ @facets = args[:facets] if args.key?(:facets)
3700
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
3701
+ @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
3702
+ @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
3703
+ @results = args[:results] if args.key?(:results)
3704
+ @total_size = args[:total_size] if args.key?(:total_size)
3705
+ end
3706
+ end
3707
+
3708
+ # A facet result.
3709
+ class GoogleCloudRetailV2betaSearchResponseFacet
3710
+ include Google::Apis::Core::Hashable
3711
+
3712
+ # Whether the facet is dynamically generated.
3713
+ # Corresponds to the JSON property `dynamicFacet`
3714
+ # @return [Boolean]
3715
+ attr_accessor :dynamic_facet
3716
+ alias_method :dynamic_facet?, :dynamic_facet
3717
+
3718
+ # The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".
3719
+ # Corresponds to the JSON property `key`
3720
+ # @return [String]
3721
+ attr_accessor :key
3722
+
3723
+ # The facet values for this field.
3724
+ # Corresponds to the JSON property `values`
3725
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacetFacetValue>]
3726
+ attr_accessor :values
3727
+
3728
+ def initialize(**args)
3729
+ update!(**args)
3730
+ end
3731
+
3732
+ # Update properties of this object
3733
+ def update!(**args)
3734
+ @dynamic_facet = args[:dynamic_facet] if args.key?(:dynamic_facet)
3735
+ @key = args[:key] if args.key?(:key)
3736
+ @values = args[:values] if args.key?(:values)
3737
+ end
3738
+ end
3739
+
3740
+ # A facet value which contains value names and their count.
3741
+ class GoogleCloudRetailV2betaSearchResponseFacetFacetValue
3742
+ include Google::Apis::Core::Hashable
3743
+
3744
+ # Number of items that have this facet value.
3745
+ # Corresponds to the JSON property `count`
3746
+ # @return [Fixnum]
3747
+ attr_accessor :count
3748
+
3749
+ # A floating point interval.
3750
+ # Corresponds to the JSON property `interval`
3751
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval]
3752
+ attr_accessor :interval
3753
+
3754
+ # Text value of a facet, such as "Black" for facet "colorFamilies".
3755
+ # Corresponds to the JSON property `value`
3756
+ # @return [String]
3757
+ attr_accessor :value
3758
+
3759
+ def initialize(**args)
3760
+ update!(**args)
3761
+ end
3762
+
3763
+ # Update properties of this object
3764
+ def update!(**args)
3765
+ @count = args[:count] if args.key?(:count)
3766
+ @interval = args[:interval] if args.key?(:interval)
3767
+ @value = args[:value] if args.key?(:value)
3768
+ end
3769
+ end
3770
+
3771
+ # Information describing query expansion including whether expansion has
3772
+ # occurred.
3773
+ class GoogleCloudRetailV2betaSearchResponseQueryExpansionInfo
3774
+ include Google::Apis::Core::Hashable
3775
+
3776
+ # Bool describing whether query expansion has occurred.
3777
+ # Corresponds to the JSON property `expandedQuery`
3778
+ # @return [Boolean]
3779
+ attr_accessor :expanded_query
3780
+ alias_method :expanded_query?, :expanded_query
3781
+
3782
+ # Number of pinned results. This field will only be set when expansion happens
3783
+ # and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
3784
+ # Corresponds to the JSON property `pinnedResultCount`
3785
+ # @return [Fixnum]
3786
+ attr_accessor :pinned_result_count
3787
+
3788
+ def initialize(**args)
3789
+ update!(**args)
3790
+ end
3791
+
3792
+ # Update properties of this object
3793
+ def update!(**args)
3794
+ @expanded_query = args[:expanded_query] if args.key?(:expanded_query)
3795
+ @pinned_result_count = args[:pinned_result_count] if args.key?(:pinned_result_count)
3796
+ end
3797
+ end
3798
+
3799
+ # Represents the search results.
3800
+ class GoogleCloudRetailV2betaSearchResponseSearchResult
3801
+ include Google::Apis::Core::Hashable
3802
+
3803
+ # Product.id of the searched Product.
3804
+ # Corresponds to the JSON property `id`
3805
+ # @return [String]
3806
+ attr_accessor :id
3807
+
3808
+ # The count of matched variant Products.
3809
+ # Corresponds to the JSON property `matchingVariantCount`
3810
+ # @return [Fixnum]
3811
+ attr_accessor :matching_variant_count
3812
+
3813
+ # If a variant Product matches the search query, this map indicates which
3814
+ # Product fields are matched. The key is the Product.name, the value is a field
3815
+ # mask of the matched Product fields. If matched attributes cannot be determined,
3816
+ # this map will be empty. For example, a key "sku1" with field mask "products.
3817
+ # color_info" indicates there is a match between "sku1" ColorInfo and the query.
3818
+ # Corresponds to the JSON property `matchingVariantFields`
3819
+ # @return [Hash<String,String>]
3820
+ attr_accessor :matching_variant_fields
3821
+
3822
+ # Product captures all metadata information of items to be recommended or
3823
+ # searched.
3824
+ # Corresponds to the JSON property `product`
3825
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct]
3826
+ attr_accessor :product
3827
+
3828
+ # The rollup matching variant Product attributes. The key is one of the
3829
+ # SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated
3830
+ # Product attributes. Notice that the rollup values are respect filter. For
3831
+ # example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "
3832
+ # colorFamilies", only "red" is returned. For textual and numerical attributes,
3833
+ # the rollup values is a list of string or double values with type google.
3834
+ # protobuf.ListValue. For example, if there are two variants with colors "red"
3835
+ # and "blue", the rollup values are ` key: "colorFamilies" value ` list_value `
3836
+ # values ` string_value: "red" ` values ` string_value: "blue" ` ` ` ` For
3837
+ # FulfillmentInfo, the rollup values is a double value with type google.protobuf.
3838
+ # Value. For example, ``key: "pickupInStore.store1" value ` number_value: 10 ```
3839
+ # means a there are 10 variants in this product are available in the store "
3840
+ # store1".
3841
+ # Corresponds to the JSON property `variantRollupValues`
3842
+ # @return [Hash<String,Object>]
3843
+ attr_accessor :variant_rollup_values
3844
+
3845
+ def initialize(**args)
3846
+ update!(**args)
3847
+ end
3848
+
3849
+ # Update properties of this object
3850
+ def update!(**args)
3851
+ @id = args[:id] if args.key?(:id)
3852
+ @matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
3853
+ @matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
3854
+ @product = args[:product] if args.key?(:product)
3855
+ @variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
3856
+ end
3857
+ end
3858
+
3859
+ # Request message to set a specified branch as new default_branch.
3860
+ class GoogleCloudRetailV2betaSetDefaultBranchRequest
3861
+ include Google::Apis::Core::Hashable
3862
+
3863
+ # The final component of the resource name of a branch. This field must be one
3864
+ # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
3865
+ # Corresponds to the JSON property `branchId`
3866
+ # @return [String]
3867
+ attr_accessor :branch_id
3868
+
3869
+ # Some note on this request, this can be retrieved by CatalogService.
3870
+ # GetDefaultBranch before next valid default branch set occurs. This field must
3871
+ # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
3872
+ # an INVALID_ARGUMENT error is returned.
3873
+ # Corresponds to the JSON property `note`
3874
+ # @return [String]
3875
+ attr_accessor :note
3876
+
3877
+ def initialize(**args)
3878
+ update!(**args)
3879
+ end
3880
+
3881
+ # Update properties of this object
3882
+ def update!(**args)
3883
+ @branch_id = args[:branch_id] if args.key?(:branch_id)
3884
+ @note = args[:note] if args.key?(:note)
3885
+ end
3886
+ end
3887
+
3888
+ # Metadata related to the progress of the SetInventory operation. Currently
3889
+ # empty because there is no meaningful metadata populated from the SetInventory
3890
+ # method.
3891
+ class GoogleCloudRetailV2betaSetInventoryMetadata
3892
+ include Google::Apis::Core::Hashable
3893
+
3894
+ def initialize(**args)
3895
+ update!(**args)
3896
+ end
3897
+
3898
+ # Update properties of this object
3899
+ def update!(**args)
3900
+ end
3901
+ end
3902
+
3903
+ # Request message for SetInventory method.
3904
+ class GoogleCloudRetailV2betaSetInventoryRequest
3905
+ include Google::Apis::Core::Hashable
3906
+
3907
+ # If set to true, and the Product with name Product.name is not found, the
3908
+ # inventory update will still be processed and retained for at most 1 day until
3909
+ # the Product is created. If set to false, an INVALID_ARGUMENT error is returned
3910
+ # if the Product is not found.
3911
+ # Corresponds to the JSON property `allowMissing`
3912
+ # @return [Boolean]
3913
+ attr_accessor :allow_missing
3914
+ alias_method :allow_missing?, :allow_missing
3915
+
3916
+ # Product captures all metadata information of items to be recommended or
3917
+ # searched.
3918
+ # Corresponds to the JSON property `inventory`
3919
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct]
3920
+ attr_accessor :inventory
3921
+
3922
+ # Indicates which inventory fields in the provided Product to update. If not set
3923
+ # or set with empty paths, all inventory fields will be updated. If an
3924
+ # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
3925
+ # returned and the entire update will be ignored.
3926
+ # Corresponds to the JSON property `setMask`
3927
+ # @return [String]
3928
+ attr_accessor :set_mask
3929
+
3930
+ # The time when the request is issued, used to prevent out-of-order updates on
3931
+ # inventory fields with the last update time recorded. If not provided, the
3932
+ # internal system time will be used.
3933
+ # Corresponds to the JSON property `setTime`
3934
+ # @return [String]
3935
+ attr_accessor :set_time
3936
+
3937
+ def initialize(**args)
3938
+ update!(**args)
3939
+ end
3940
+
3941
+ # Update properties of this object
3942
+ def update!(**args)
3943
+ @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
3944
+ @inventory = args[:inventory] if args.key?(:inventory)
3945
+ @set_mask = args[:set_mask] if args.key?(:set_mask)
3946
+ @set_time = args[:set_time] if args.key?(:set_time)
3947
+ end
3948
+ end
3949
+
3950
+ # Response of the SetInventoryRequest. Currently empty because there is no
3951
+ # meaningful response populated from the SetInventory method.
3952
+ class GoogleCloudRetailV2betaSetInventoryResponse
3953
+ include Google::Apis::Core::Hashable
3954
+
3955
+ def initialize(**args)
3956
+ update!(**args)
3957
+ end
3958
+
3959
+ # Update properties of this object
3960
+ def update!(**args)
3961
+ end
3962
+ end
3963
+
2005
3964
  # UserEvent captures all metadata information Retail API needs to know about how
2006
3965
  # end users interact with customers' website.
2007
3966
  class GoogleCloudRetailV2betaUserEvent
@@ -2020,18 +3979,19 @@ module Google
2020
3979
  # Highly recommended for user events that are the result of PredictionService.
2021
3980
  # Predict. This field enables accurate attribution of recommendation model
2022
3981
  # performance. The value must be a valid PredictResponse.attribution_token for
2023
- # user events that are the result of PredictionService.Predict. This token
2024
- # enables us to accurately attribute page view or purchase back to the event and
2025
- # the particular predict response containing this clicked/purchased product. If
2026
- # user clicks on product K in the recommendation results, pass PredictResponse.
2027
- # attribution_token as a URL parameter to product K's page. When recording
2028
- # events on product K's page, log the PredictResponse.attribution_token to this
2029
- # field.
3982
+ # user events that are the result of PredictionService.Predict. The value must
3983
+ # be a valid SearchResponse.attribution_token for user events that are the
3984
+ # result of SearchService.Search. This token enables us to accurately attribute
3985
+ # page view or purchase back to the event and the particular predict response
3986
+ # containing this clicked/purchased product. If user clicks on product K in the
3987
+ # recommendation results, pass PredictResponse.attribution_token as a URL
3988
+ # parameter to product K's page. When recording events on product K's page, log
3989
+ # the PredictResponse.attribution_token to this field.
2030
3990
  # Corresponds to the JSON property `attributionToken`
2031
3991
  # @return [String]
2032
3992
  attr_accessor :attribution_token
2033
3993
 
2034
- # The id or name of the associated shopping cart. This id is used to associate
3994
+ # The ID or name of the associated shopping cart. This ID is used to associate
2035
3995
  # multiple items added or present in the cart before purchase. This can only be
2036
3996
  # set for `add-to-cart`, `purchase-complete`, or `shopping-cart-page-view`
2037
3997
  # events.
@@ -2039,6 +3999,12 @@ module Google
2039
3999
  # @return [String]
2040
4000
  attr_accessor :cart_id
2041
4001
 
4002
+ # Detailed completion information including completion attribution token and
4003
+ # clicked completion info.
4004
+ # Corresponds to the JSON property `completionDetail`
4005
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDetail]
4006
+ attr_accessor :completion_detail
4007
+
2042
4008
  # Only required for UserEventService.ImportUserEvents method. Timestamp of when
2043
4009
  # the user event happened.
2044
4010
  # Corresponds to the JSON property `eventTime`
@@ -2065,6 +4031,34 @@ module Google
2065
4031
  # @return [Array<String>]
2066
4032
  attr_accessor :experiment_ids
2067
4033
 
4034
+ # The filter syntax consists of an expression language for constructing a
4035
+ # predicate from one or more fields of the products being filtered. See
4036
+ # SearchRequest.filter for definition and syntax. The value must be a UTF-8
4037
+ # encoded string with a length limit of 1,000 characters. Otherwise, an
4038
+ # INVALID_ARGUMENT error is returned.
4039
+ # Corresponds to the JSON property `filter`
4040
+ # @return [String]
4041
+ attr_accessor :filter
4042
+
4043
+ # An integer that specifies the current offset for pagination (the 0-indexed
4044
+ # starting location, amongst the products deemed by the API as relevant). See
4045
+ # SearchRequest.offset for definition. If this field is negative, an
4046
+ # INVALID_ARGUMENT is returned. This can only be set for `search` events. Other
4047
+ # event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
4048
+ # returned.
4049
+ # Corresponds to the JSON property `offset`
4050
+ # @return [Fixnum]
4051
+ attr_accessor :offset
4052
+
4053
+ # The order in which products are returned. See SearchRequest.order_by for
4054
+ # definition and syntax. The value must be a UTF-8 encoded string with a length
4055
+ # limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
4056
+ # This can only be set for `search` events. Other event types should not set
4057
+ # this field. Otherwise, an INVALID_ARGUMENT error is returned.
4058
+ # Corresponds to the JSON property `orderBy`
4059
+ # @return [String]
4060
+ attr_accessor :order_by
4061
+
2068
4062
  # The categories associated with a category page. To represent full path of
2069
4063
  # category, use '>' sign to separate different hierarchies. If '>' is part of
2070
4064
  # the category name, please replace it with other character(s). Category pages
@@ -2078,7 +4072,7 @@ module Google
2078
4072
  # @return [Array<String>]
2079
4073
  attr_accessor :page_categories
2080
4074
 
2081
- # A unique id of a web page view. This should be kept the same for all user
4075
+ # A unique ID of a web page view. This should be kept the same for all user
2082
4076
  # events triggered from the same pageview. For example, an item detail page view
2083
4077
  # could trigger multiple events as the user is browsing the page. The `
2084
4078
  # pageViewId` property should be kept the same for all these events so that they
@@ -2092,11 +4086,11 @@ module Google
2092
4086
  # The main product details related to the event. This field is required for the
2093
4087
  # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
2094
4088
  # complete` In a `search` event, this field represents the products returned to
2095
- # the end user on the current page (the end user may have not finished broswing
4089
+ # the end user on the current page (the end user may have not finished browsing
2096
4090
  # the whole page yet). When a new page is returned to the end user, after
2097
4091
  # pagination/filtering/ordering even for the same query, a new `search` event
2098
4092
  # with different product_details is desired. The end user may have not finished
2099
- # broswing the whole page yet.
4093
+ # browsing the whole page yet.
2100
4094
  # Corresponds to the JSON property `productDetails`
2101
4095
  # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductDetail>]
2102
4096
  attr_accessor :product_details
@@ -2113,15 +4107,24 @@ module Google
2113
4107
  # @return [String]
2114
4108
  attr_accessor :referrer_uri
2115
4109
 
2116
- # The user's search query. The value must be a UTF-8 encoded string with a
2117
- # length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
2118
- # returned. At least one of search_query or page_categories is required for `
2119
- # search` events. Other event types should not set this field. Otherwise, an
2120
- # INVALID_ARGUMENT error is returned.
4110
+ # The user's search query. See SearchRequest.query for definition. The value
4111
+ # must be a UTF-8 encoded string with a length limit of 5,000 characters.
4112
+ # Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query
4113
+ # or page_categories is required for `search` events. Other event types should
4114
+ # not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
2121
4115
  # Corresponds to the JSON property `searchQuery`
2122
4116
  # @return [String]
2123
4117
  attr_accessor :search_query
2124
4118
 
4119
+ # A unique identifier for tracking a visitor session with a length limit of 128
4120
+ # bytes. A session is an aggregation of an end user behavior in a time span. A
4121
+ # general guideline to populate the sesion_id: 1. If user has no activity for 30
4122
+ # min, a new session_id should be assigned. 2. The session_id should be unique
4123
+ # across users, suggest use uuid or add visitor_id as prefix.
4124
+ # Corresponds to the JSON property `sessionId`
4125
+ # @return [String]
4126
+ attr_accessor :session_id
4127
+
2125
4128
  # Complete URL (window.location.href) of the user's current page. When using the
2126
4129
  # client side event reporting with JavaScript pixel and Google Tag Manager, this
2127
4130
  # value is filled in automatically. Maximum length 5,000 characters.
@@ -2155,15 +4158,20 @@ module Google
2155
4158
  @attributes = args[:attributes] if args.key?(:attributes)
2156
4159
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
2157
4160
  @cart_id = args[:cart_id] if args.key?(:cart_id)
4161
+ @completion_detail = args[:completion_detail] if args.key?(:completion_detail)
2158
4162
  @event_time = args[:event_time] if args.key?(:event_time)
2159
4163
  @event_type = args[:event_type] if args.key?(:event_type)
2160
4164
  @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
4165
+ @filter = args[:filter] if args.key?(:filter)
4166
+ @offset = args[:offset] if args.key?(:offset)
4167
+ @order_by = args[:order_by] if args.key?(:order_by)
2161
4168
  @page_categories = args[:page_categories] if args.key?(:page_categories)
2162
4169
  @page_view_id = args[:page_view_id] if args.key?(:page_view_id)
2163
4170
  @product_details = args[:product_details] if args.key?(:product_details)
2164
4171
  @purchase_transaction = args[:purchase_transaction] if args.key?(:purchase_transaction)
2165
4172
  @referrer_uri = args[:referrer_uri] if args.key?(:referrer_uri)
2166
4173
  @search_query = args[:search_query] if args.key?(:search_query)
4174
+ @session_id = args[:session_id] if args.key?(:session_id)
2167
4175
  @uri = args[:uri] if args.key?(:uri)
2168
4176
  @user_info = args[:user_info] if args.key?(:user_info)
2169
4177
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -2262,7 +4270,7 @@ module Google
2262
4270
  attr_accessor :direct_user_request
2263
4271
  alias_method :direct_user_request?, :direct_user_request
2264
4272
 
2265
- # The end user's IP address. Required for getting SearchRespons.
4273
+ # The end user's IP address. Required for getting SearchResponse.
2266
4274
  # sponsored_results. This field is used to extract location information for
2267
4275
  # personalization. This field must be either an IPv4 address (e.g. "104.133.9.80"
2268
4276
  # ) or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
@@ -2273,7 +4281,7 @@ module Google
2273
4281
  # @return [String]
2274
4282
  attr_accessor :ip_address
2275
4283
 
2276
- # User agent as included in the HTTP header. Required for getting SearchRespons.
4284
+ # User agent as included in the HTTP header. Required for getting SearchResponse.
2277
4285
  # sponsored_results. The field must be a UTF-8 encoded string with a length
2278
4286
  # limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2279
4287
  # This should not be set when using the client side event reporting with GTM or
@@ -2445,6 +4453,47 @@ module Google
2445
4453
  @message = args[:message] if args.key?(:message)
2446
4454
  end
2447
4455
  end
4456
+
4457
+ # Represents a whole or partial calendar date, such as a birthday. The time of
4458
+ # day and time zone are either specified elsewhere or are insignificant. The
4459
+ # date is relative to the Gregorian Calendar. This can represent one of the
4460
+ # following: * A full date, with non-zero year, month, and day values * A month
4461
+ # and day value, with a zero year, such as an anniversary * A year on its own,
4462
+ # with zero month and day values * A year and month value, with a zero day, such
4463
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
4464
+ # google.protobuf.Timestamp`.
4465
+ class GoogleTypeDate
4466
+ include Google::Apis::Core::Hashable
4467
+
4468
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
4469
+ # specify a year by itself or a year and month where the day isn't significant.
4470
+ # Corresponds to the JSON property `day`
4471
+ # @return [Fixnum]
4472
+ attr_accessor :day
4473
+
4474
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
4475
+ # and day.
4476
+ # Corresponds to the JSON property `month`
4477
+ # @return [Fixnum]
4478
+ attr_accessor :month
4479
+
4480
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
4481
+ # year.
4482
+ # Corresponds to the JSON property `year`
4483
+ # @return [Fixnum]
4484
+ attr_accessor :year
4485
+
4486
+ def initialize(**args)
4487
+ update!(**args)
4488
+ end
4489
+
4490
+ # Update properties of this object
4491
+ def update!(**args)
4492
+ @day = args[:day] if args.key?(:day)
4493
+ @month = args[:month] if args.key?(:month)
4494
+ @year = args[:year] if args.key?(:year)
4495
+ end
4496
+ end
2448
4497
  end
2449
4498
  end
2450
4499
  end