google-apis-retail_v2alpha 0.24.0 → 0.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -821,30 +821,15 @@ module Google
821
821
  execute_or_queue_command(command, &block)
822
822
  end
823
823
 
824
- # Set local inventory information for a Product with the provided list of places
825
- # at a set timestamp. If a place in the provided list does not exist, the place
826
- # will be created. If a place in the provided list already exists, it will be
827
- # updated while respecting the last update timestamps of each inventory field.
828
- # If an existing place is not in the provided list, it will be removed. This
829
- # process is asynchronous. If the request is valid, the set operation will be
830
- # enqueued and processed downstream. As a consequence, when a response is
831
- # returned, set operations are not immediately manifested in the Product queried
832
- # by GetProduct or ListProducts. When applying the set operation, this process
833
- # takes a snapshot of currently existing places and their corresponding
834
- # timestamps to determine the places to update. Avoid concurrent
835
- # AddLocalInventories and RemoveLocalInventories calls, since they can introduce
836
- # asynchronous updates that could be missed by the set operation. Local
837
- # inventory information can only be updated with this method and other local
838
- # inventory-specific methods. CreateProduct and UpdateProduct has no effect on
839
- # local inventories. This feature is only available for users who have Retail
840
- # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
841
- # to contact Cloud sales if you are interested in using Retail Search.
842
- # @param [String] product
843
- # Required. Full resource name of Product, such as `projects/*/locations/global/
844
- # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
845
- # the caller does not have permission to access the Product, regardless of
846
- # whether or not it exists, a PERMISSION_DENIED error is returned.
847
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest] google_cloud_retail_v2alpha_set_local_inventories_request_object
824
+ # Bulk import of processed completion dataset. Request processing may be
825
+ # synchronous. Partial updating is not supported. This feature is only available
826
+ # for users who have Retail Search enabled. Please submit a form [here](https://
827
+ # cloud.google.com/contact) to contact cloud sales if you are interested in
828
+ # using Retail Search.
829
+ # @param [String] parent
830
+ # Required. The catalog which the suggestions dataset belongs to. Format: `
831
+ # projects/1234/locations/global/catalogs/default_catalog`.
832
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest] google_cloud_retail_v2alpha_import_completion_data_request_object
848
833
  # @param [String] fields
849
834
  # Selector specifying which fields to include in a partial response.
850
835
  # @param [String] quota_user
@@ -862,27 +847,28 @@ module Google
862
847
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
863
848
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
864
849
  # @raise [Google::Apis::AuthorizationError] Authorization is required
865
- def set_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_set_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
866
- command = make_simple_command(:post, 'v2alpha/{+product}:setLocalInventories', options)
867
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest::Representation
868
- command.request_object = google_cloud_retail_v2alpha_set_local_inventories_request_object
850
+ def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
851
+ command = make_simple_command(:post, 'v2alpha/{+parent}/completionData:import', options)
852
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest::Representation
853
+ command.request_object = google_cloud_retail_v2alpha_import_completion_data_request_object
869
854
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
870
855
  command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
871
- command.params['product'] = product unless product.nil?
856
+ command.params['parent'] = parent unless parent.nil?
872
857
  command.query['fields'] = fields unless fields.nil?
873
858
  command.query['quotaUser'] = quota_user unless quota_user.nil?
874
859
  execute_or_queue_command(command, &block)
875
860
  end
876
861
 
877
- # Bulk import of processed completion dataset. Request processing may be
878
- # synchronous. Partial updating is not supported. This feature is only available
879
- # for users who have Retail Search enabled. Please submit a form [here](https://
880
- # cloud.google.com/contact) to contact cloud sales if you are interested in
881
- # using Retail Search.
862
+ # Creates a Control. If the Control to create already exists, an ALREADY_EXISTS
863
+ # error is returned.
882
864
  # @param [String] parent
883
- # Required. The catalog which the suggestions dataset belongs to. Format: `
884
- # projects/1234/locations/global/catalogs/default_catalog`.
885
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest] google_cloud_retail_v2alpha_import_completion_data_request_object
865
+ # Required. Full resource name of parent catalog. Format: projects/`
866
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`
867
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] google_cloud_retail_v2alpha_control_object
868
+ # @param [String] control_id
869
+ # Required. The ID to use for the Control, which will become the final component
870
+ # of the Control's resource name. This value should be 4-63 characters, and
871
+ # valid characters are /a-z-_/.
886
872
  # @param [String] fields
887
873
  # Selector specifying which fields to include in a partial response.
888
874
  # @param [String] quota_user
@@ -892,21 +878,173 @@ module Google
892
878
  # Request-specific options
893
879
  #
894
880
  # @yield [result, err] Result & error if block supplied
895
- # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
881
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
896
882
  # @yieldparam err [StandardError] error object if request failed
897
883
  #
898
- # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
884
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
899
885
  #
900
886
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
901
887
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
902
888
  # @raise [Google::Apis::AuthorizationError] Authorization is required
903
- def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
904
- command = make_simple_command(:post, 'v2alpha/{+parent}/completionData:import', options)
905
- command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest::Representation
906
- command.request_object = google_cloud_retail_v2alpha_import_completion_data_request_object
907
- command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
908
- command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
889
+ def create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
890
+ command = make_simple_command(:post, 'v2alpha/{+parent}/controls', options)
891
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
892
+ command.request_object = google_cloud_retail_v2alpha_control_object
893
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
894
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
909
895
  command.params['parent'] = parent unless parent.nil?
896
+ command.query['controlId'] = control_id unless control_id.nil?
897
+ command.query['fields'] = fields unless fields.nil?
898
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
899
+ execute_or_queue_command(command, &block)
900
+ end
901
+
902
+ # Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
903
+ # is returned.
904
+ # @param [String] name
905
+ # Required. The resource name of the Control to delete. Format: projects/`
906
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
907
+ # control_id`
908
+ # @param [String] fields
909
+ # Selector specifying which fields to include in a partial response.
910
+ # @param [String] quota_user
911
+ # Available to use for quota purposes for server-side applications. Can be any
912
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
913
+ # @param [Google::Apis::RequestOptions] options
914
+ # Request-specific options
915
+ #
916
+ # @yield [result, err] Result & error if block supplied
917
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
918
+ # @yieldparam err [StandardError] error object if request failed
919
+ #
920
+ # @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
921
+ #
922
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
923
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
924
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
925
+ def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
926
+ command = make_simple_command(:delete, 'v2alpha/{+name}', options)
927
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
928
+ command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
929
+ command.params['name'] = name unless name.nil?
930
+ command.query['fields'] = fields unless fields.nil?
931
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
932
+ execute_or_queue_command(command, &block)
933
+ end
934
+
935
+ # Gets a Control.
936
+ # @param [String] name
937
+ # Required. The resource name of the Control to delete. Format: projects/`
938
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
939
+ # control_id`
940
+ # @param [String] fields
941
+ # Selector specifying which fields to include in a partial response.
942
+ # @param [String] quota_user
943
+ # Available to use for quota purposes for server-side applications. Can be any
944
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
945
+ # @param [Google::Apis::RequestOptions] options
946
+ # Request-specific options
947
+ #
948
+ # @yield [result, err] Result & error if block supplied
949
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
950
+ # @yieldparam err [StandardError] error object if request failed
951
+ #
952
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
953
+ #
954
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
955
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
956
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
957
+ def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
958
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
959
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
960
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
961
+ command.params['name'] = name unless name.nil?
962
+ command.query['fields'] = fields unless fields.nil?
963
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
964
+ execute_or_queue_command(command, &block)
965
+ end
966
+
967
+ # Lists all Controls linked to this catalog.
968
+ # @param [String] parent
969
+ # Required. The catalog resource name. Format: projects/`project_number`/
970
+ # locations/`location_id`/catalogs/`catalog_id`
971
+ # @param [String] filter
972
+ # Optional. A filter to apply on the list results. Supported features: * List
973
+ # all the products under the parent branch if filter is unset. * List controls
974
+ # that are used in a single ServingConfig: 'serving_config = "
975
+ # boosted_home_page_cvr"'
976
+ # @param [Fixnum] page_size
977
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
978
+ # Max allowed value is 1000.
979
+ # @param [String] page_token
980
+ # Optional. A page token, received from a previous `ListControls` call. Provide
981
+ # this to retrieve the subsequent page.
982
+ # @param [String] fields
983
+ # Selector specifying which fields to include in a partial response.
984
+ # @param [String] quota_user
985
+ # Available to use for quota purposes for server-side applications. Can be any
986
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
987
+ # @param [Google::Apis::RequestOptions] options
988
+ # Request-specific options
989
+ #
990
+ # @yield [result, err] Result & error if block supplied
991
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse] parsed result object
992
+ # @yieldparam err [StandardError] error object if request failed
993
+ #
994
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse]
995
+ #
996
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
997
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
998
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
999
+ def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1000
+ command = make_simple_command(:get, 'v2alpha/{+parent}/controls', options)
1001
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse::Representation
1002
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse
1003
+ command.params['parent'] = parent unless parent.nil?
1004
+ command.query['filter'] = filter unless filter.nil?
1005
+ command.query['pageSize'] = page_size unless page_size.nil?
1006
+ command.query['pageToken'] = page_token unless page_token.nil?
1007
+ command.query['fields'] = fields unless fields.nil?
1008
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1009
+ execute_or_queue_command(command, &block)
1010
+ end
1011
+
1012
+ # Updates a Control. Control cannot be set to a different oneof field, if so an
1013
+ # INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
1014
+ # NOT_FOUND error is returned.
1015
+ # @param [String] name
1016
+ # Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
1017
+ # controls/*
1018
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] google_cloud_retail_v2alpha_control_object
1019
+ # @param [String] update_mask
1020
+ # Indicates which fields in the provided Control to update. The following are
1021
+ # NOT supported: * Control.name If not set or empty, all supported fields are
1022
+ # updated.
1023
+ # @param [String] fields
1024
+ # Selector specifying which fields to include in a partial response.
1025
+ # @param [String] quota_user
1026
+ # Available to use for quota purposes for server-side applications. Can be any
1027
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1028
+ # @param [Google::Apis::RequestOptions] options
1029
+ # Request-specific options
1030
+ #
1031
+ # @yield [result, err] Result & error if block supplied
1032
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
1033
+ # @yieldparam err [StandardError] error object if request failed
1034
+ #
1035
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
1036
+ #
1037
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1038
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1039
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1040
+ def patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1041
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
1042
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
1043
+ command.request_object = google_cloud_retail_v2alpha_control_object
1044
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
1045
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
1046
+ command.params['name'] = name unless name.nil?
1047
+ command.query['updateMask'] = update_mask unless update_mask.nil?
910
1048
  command.query['fields'] = fields unless fields.nil?
911
1049
  command.query['quotaUser'] = quota_user unless quota_user.nil?
912
1050
  execute_or_queue_command(command, &block)
@@ -1066,6 +1204,267 @@ module Google
1066
1204
  execute_or_queue_command(command, &block)
1067
1205
  end
1068
1206
 
1207
+ # Enables a Control on the specified ServingConfig. The control is added in the
1208
+ # last position of the list of controls it belongs to (e.g. if it's a facet spec
1209
+ # control it will be applied in the last position of servingConfig.facetSpecIds)
1210
+ # Returns a ALREADY_EXISTS error if the control has already been applied.
1211
+ # Returns a FAILED_PRECONDITION error if the addition could exceed maximum
1212
+ # number of control allowed for that type of control.
1213
+ # @param [String] serving_config
1214
+ # Required. The source ServingConfig resource name . Format: projects/`
1215
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1216
+ # serving_config_id`
1217
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest] google_cloud_retail_v2alpha_add_control_request_object
1218
+ # @param [String] fields
1219
+ # Selector specifying which fields to include in a partial response.
1220
+ # @param [String] quota_user
1221
+ # Available to use for quota purposes for server-side applications. Can be any
1222
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1223
+ # @param [Google::Apis::RequestOptions] options
1224
+ # Request-specific options
1225
+ #
1226
+ # @yield [result, err] Result & error if block supplied
1227
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
1228
+ # @yieldparam err [StandardError] error object if request failed
1229
+ #
1230
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
1231
+ #
1232
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1233
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1234
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1235
+ def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1236
+ command = make_simple_command(:post, 'v2alpha/{+servingConfig}:addControl', options)
1237
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest::Representation
1238
+ command.request_object = google_cloud_retail_v2alpha_add_control_request_object
1239
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1240
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
1241
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1242
+ command.query['fields'] = fields unless fields.nil?
1243
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1244
+ execute_or_queue_command(command, &block)
1245
+ end
1246
+
1247
+ # Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
1248
+ # Catalog, otherwise a FAILED_PRECONDITION error is returned.
1249
+ # @param [String] parent
1250
+ # Required. Full resource name of parent. Format: projects/`project_number`/
1251
+ # locations/`location_id`/catalogs/`catalog_id`
1252
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] google_cloud_retail_v2alpha_serving_config_object
1253
+ # @param [String] serving_config_id
1254
+ # Required. The ID to use for the ServingConfig, which will become the final
1255
+ # component of the ServingConfig's resource name. This value should be 4-63
1256
+ # characters, and valid characters are /a-z-_/.
1257
+ # @param [String] fields
1258
+ # Selector specifying which fields to include in a partial response.
1259
+ # @param [String] quota_user
1260
+ # Available to use for quota purposes for server-side applications. Can be any
1261
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1262
+ # @param [Google::Apis::RequestOptions] options
1263
+ # Request-specific options
1264
+ #
1265
+ # @yield [result, err] Result & error if block supplied
1266
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
1267
+ # @yieldparam err [StandardError] error object if request failed
1268
+ #
1269
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
1270
+ #
1271
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1272
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1273
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1274
+ def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1275
+ command = make_simple_command(:post, 'v2alpha/{+parent}/servingConfigs', options)
1276
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1277
+ command.request_object = google_cloud_retail_v2alpha_serving_config_object
1278
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1279
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
1280
+ command.params['parent'] = parent unless parent.nil?
1281
+ command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil?
1282
+ command.query['fields'] = fields unless fields.nil?
1283
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1284
+ execute_or_queue_command(command, &block)
1285
+ end
1286
+
1287
+ # Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
1288
+ # not exist.
1289
+ # @param [String] name
1290
+ # Required. The resource name of the ServingConfig to delete. Format: projects/`
1291
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1292
+ # serving_config_id`
1293
+ # @param [String] fields
1294
+ # Selector specifying which fields to include in a partial response.
1295
+ # @param [String] quota_user
1296
+ # Available to use for quota purposes for server-side applications. Can be any
1297
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1298
+ # @param [Google::Apis::RequestOptions] options
1299
+ # Request-specific options
1300
+ #
1301
+ # @yield [result, err] Result & error if block supplied
1302
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
1303
+ # @yieldparam err [StandardError] error object if request failed
1304
+ #
1305
+ # @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
1306
+ #
1307
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1308
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1309
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1310
+ def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
1311
+ command = make_simple_command(:delete, 'v2alpha/{+name}', options)
1312
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
1313
+ command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
1314
+ command.params['name'] = name unless name.nil?
1315
+ command.query['fields'] = fields unless fields.nil?
1316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1317
+ execute_or_queue_command(command, &block)
1318
+ end
1319
+
1320
+ # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1321
+ # exist.
1322
+ # @param [String] name
1323
+ # Required. The resource name of the ServingConfig to get. Format: projects/`
1324
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1325
+ # serving_config_id`
1326
+ # @param [String] fields
1327
+ # Selector specifying which fields to include in a partial response.
1328
+ # @param [String] quota_user
1329
+ # Available to use for quota purposes for server-side applications. Can be any
1330
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1331
+ # @param [Google::Apis::RequestOptions] options
1332
+ # Request-specific options
1333
+ #
1334
+ # @yield [result, err] Result & error if block supplied
1335
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
1336
+ # @yieldparam err [StandardError] error object if request failed
1337
+ #
1338
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
1339
+ #
1340
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1341
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1342
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1343
+ def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
1344
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
1345
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1346
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
1347
+ command.params['name'] = name unless name.nil?
1348
+ command.query['fields'] = fields unless fields.nil?
1349
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1350
+ execute_or_queue_command(command, &block)
1351
+ end
1352
+
1353
+ # Lists all ServingConfigs linked to this catalog.
1354
+ # @param [String] parent
1355
+ # Required. The catalog resource name. Format: projects/`project_number`/
1356
+ # locations/`location_id`/catalogs/`catalog_id`
1357
+ # @param [Fixnum] page_size
1358
+ # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1359
+ # If a value greater than 100 is provided, at most 100 results are returned.
1360
+ # @param [String] page_token
1361
+ # Optional. A page token, received from a previous `ListServingConfigs` call.
1362
+ # Provide this to retrieve the subsequent page.
1363
+ # @param [String] fields
1364
+ # Selector specifying which fields to include in a partial response.
1365
+ # @param [String] quota_user
1366
+ # Available to use for quota purposes for server-side applications. Can be any
1367
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1368
+ # @param [Google::Apis::RequestOptions] options
1369
+ # Request-specific options
1370
+ #
1371
+ # @yield [result, err] Result & error if block supplied
1372
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse] parsed result object
1373
+ # @yieldparam err [StandardError] error object if request failed
1374
+ #
1375
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse]
1376
+ #
1377
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1378
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1379
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1380
+ def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1381
+ command = make_simple_command(:get, 'v2alpha/{+parent}/servingConfigs', options)
1382
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse::Representation
1383
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse
1384
+ command.params['parent'] = parent unless parent.nil?
1385
+ command.query['pageSize'] = page_size unless page_size.nil?
1386
+ command.query['pageToken'] = page_token unless page_token.nil?
1387
+ command.query['fields'] = fields unless fields.nil?
1388
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1389
+ execute_or_queue_command(command, &block)
1390
+ end
1391
+
1392
+ # Updates a ServingConfig.
1393
+ # @param [String] name
1394
+ # Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
1395
+ # servingConfig/*
1396
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] google_cloud_retail_v2alpha_serving_config_object
1397
+ # @param [String] update_mask
1398
+ # Indicates which fields in the provided ServingConfig to update. The following
1399
+ # are NOT supported: * ServingConfig.name If not set, all supported fields are
1400
+ # updated.
1401
+ # @param [String] fields
1402
+ # Selector specifying which fields to include in a partial response.
1403
+ # @param [String] quota_user
1404
+ # Available to use for quota purposes for server-side applications. Can be any
1405
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1406
+ # @param [Google::Apis::RequestOptions] options
1407
+ # Request-specific options
1408
+ #
1409
+ # @yield [result, err] Result & error if block supplied
1410
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
1411
+ # @yieldparam err [StandardError] error object if request failed
1412
+ #
1413
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
1414
+ #
1415
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1416
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1417
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1418
+ def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1419
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
1420
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1421
+ command.request_object = google_cloud_retail_v2alpha_serving_config_object
1422
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1423
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
1424
+ command.params['name'] = name unless name.nil?
1425
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1426
+ command.query['fields'] = fields unless fields.nil?
1427
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1428
+ execute_or_queue_command(command, &block)
1429
+ end
1430
+
1431
+ # Disables a Control on the specified ServingConfig. The control is removed from
1432
+ # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1433
+ # the ServingConfig.
1434
+ # @param [String] serving_config
1435
+ # Required. The source ServingConfig resource name . Format: projects/`
1436
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1437
+ # serving_config_id`
1438
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest] google_cloud_retail_v2alpha_remove_control_request_object
1439
+ # @param [String] fields
1440
+ # Selector specifying which fields to include in a partial response.
1441
+ # @param [String] quota_user
1442
+ # Available to use for quota purposes for server-side applications. Can be any
1443
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1444
+ # @param [Google::Apis::RequestOptions] options
1445
+ # Request-specific options
1446
+ #
1447
+ # @yield [result, err] Result & error if block supplied
1448
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
1449
+ # @yieldparam err [StandardError] error object if request failed
1450
+ #
1451
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
1452
+ #
1453
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1454
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1455
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1456
+ def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1457
+ command = make_simple_command(:post, 'v2alpha/{+servingConfig}:removeControl', options)
1458
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest::Representation
1459
+ command.request_object = google_cloud_retail_v2alpha_remove_control_request_object
1460
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
1461
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
1462
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
1463
+ command.query['fields'] = fields unless fields.nil?
1464
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1465
+ execute_or_queue_command(command, &block)
1466
+ end
1467
+
1069
1468
  # Writes a single user event from the browser. This uses a GET request to due to
1070
1469
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1071
1470
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.24.0
4
+ version: 0.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-10 00:00:00.000000000 Z
11
+ date: 2022-02-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.24.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.28.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.4
78
+ rubygems_version: 3.3.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Retail API V2alpha