google-apis-retail_v2beta 0.24.0 → 0.28.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -124,10 +124,7 @@ module Google
|
|
124
124
|
end
|
125
125
|
|
126
126
|
# Get which branch is currently default branch set by CatalogService.
|
127
|
-
# SetDefaultBranch method under a specified parent catalog.
|
128
|
-
# available for users who have Retail Search enabled. Please submit a form [here]
|
129
|
-
# (https://cloud.google.com/contact) to contact cloud sales if you are
|
130
|
-
# interested in using Retail Search.
|
127
|
+
# SetDefaultBranch method under a specified parent catalog.
|
131
128
|
# @param [String] catalog
|
132
129
|
# The parent catalog resource name, such as `projects/*/locations/global/
|
133
130
|
# catalogs/default_catalog`.
|
@@ -256,9 +253,7 @@ module Google
|
|
256
253
|
# PredictionService will only return product IDs from branch `newBranch`. *
|
257
254
|
# SearchService will only return product IDs from branch `newBranch` (if branch
|
258
255
|
# is not explicitly set). * UserEventService will only join events with products
|
259
|
-
# from branch `newBranch`.
|
260
|
-
# Retail Search enabled. Please submit a form [here](https://cloud.google.com/
|
261
|
-
# contact) to contact cloud sales if you are interested in using Retail Search.
|
256
|
+
# from branch `newBranch`.
|
262
257
|
# @param [String] catalog
|
263
258
|
# Full resource name of the catalog, such as `projects/*/locations/global/
|
264
259
|
# catalogs/default_catalog`.
|
@@ -764,6 +759,197 @@ module Google
|
|
764
759
|
execute_or_queue_command(command, &block)
|
765
760
|
end
|
766
761
|
|
762
|
+
# Creates a Control. If the Control to create already exists, an ALREADY_EXISTS
|
763
|
+
# error is returned.
|
764
|
+
# @param [String] parent
|
765
|
+
# Required. Full resource name of parent catalog. Format: projects/`
|
766
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`
|
767
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] google_cloud_retail_v2beta_control_object
|
768
|
+
# @param [String] control_id
|
769
|
+
# Required. The ID to use for the Control, which will become the final component
|
770
|
+
# of the Control's resource name. This value should be 4-63 characters, and
|
771
|
+
# valid characters are /a-z-_/.
|
772
|
+
# @param [String] fields
|
773
|
+
# Selector specifying which fields to include in a partial response.
|
774
|
+
# @param [String] quota_user
|
775
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
776
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
777
|
+
# @param [Google::Apis::RequestOptions] options
|
778
|
+
# Request-specific options
|
779
|
+
#
|
780
|
+
# @yield [result, err] Result & error if block supplied
|
781
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
782
|
+
# @yieldparam err [StandardError] error object if request failed
|
783
|
+
#
|
784
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
785
|
+
#
|
786
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
787
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
788
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
789
|
+
def create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
790
|
+
command = make_simple_command(:post, 'v2beta/{+parent}/controls', options)
|
791
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
792
|
+
command.request_object = google_cloud_retail_v2beta_control_object
|
793
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
794
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
795
|
+
command.params['parent'] = parent unless parent.nil?
|
796
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
797
|
+
command.query['fields'] = fields unless fields.nil?
|
798
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
799
|
+
execute_or_queue_command(command, &block)
|
800
|
+
end
|
801
|
+
|
802
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
803
|
+
# is returned.
|
804
|
+
# @param [String] name
|
805
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
806
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
807
|
+
# control_id`
|
808
|
+
# @param [String] fields
|
809
|
+
# Selector specifying which fields to include in a partial response.
|
810
|
+
# @param [String] quota_user
|
811
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
812
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
813
|
+
# @param [Google::Apis::RequestOptions] options
|
814
|
+
# Request-specific options
|
815
|
+
#
|
816
|
+
# @yield [result, err] Result & error if block supplied
|
817
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleProtobufEmpty] parsed result object
|
818
|
+
# @yieldparam err [StandardError] error object if request failed
|
819
|
+
#
|
820
|
+
# @return [Google::Apis::RetailV2beta::GoogleProtobufEmpty]
|
821
|
+
#
|
822
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
823
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
824
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
825
|
+
def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
826
|
+
command = make_simple_command(:delete, 'v2beta/{+name}', options)
|
827
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
|
828
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
|
829
|
+
command.params['name'] = name unless name.nil?
|
830
|
+
command.query['fields'] = fields unless fields.nil?
|
831
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
832
|
+
execute_or_queue_command(command, &block)
|
833
|
+
end
|
834
|
+
|
835
|
+
# Gets a Control.
|
836
|
+
# @param [String] name
|
837
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
838
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
839
|
+
# control_id`
|
840
|
+
# @param [String] fields
|
841
|
+
# Selector specifying which fields to include in a partial response.
|
842
|
+
# @param [String] quota_user
|
843
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
844
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
845
|
+
# @param [Google::Apis::RequestOptions] options
|
846
|
+
# Request-specific options
|
847
|
+
#
|
848
|
+
# @yield [result, err] Result & error if block supplied
|
849
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
850
|
+
# @yieldparam err [StandardError] error object if request failed
|
851
|
+
#
|
852
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
853
|
+
#
|
854
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
855
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
856
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
857
|
+
def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
858
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
859
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
860
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
861
|
+
command.params['name'] = name unless name.nil?
|
862
|
+
command.query['fields'] = fields unless fields.nil?
|
863
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
864
|
+
execute_or_queue_command(command, &block)
|
865
|
+
end
|
866
|
+
|
867
|
+
# Lists all Controls linked to this catalog.
|
868
|
+
# @param [String] parent
|
869
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
870
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
871
|
+
# @param [String] filter
|
872
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
873
|
+
# all the products under the parent branch if filter is unset. * List controls
|
874
|
+
# that are used in a single ServingConfig: 'serving_config = "
|
875
|
+
# boosted_home_page_cvr"'
|
876
|
+
# @param [Fixnum] page_size
|
877
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
878
|
+
# Max allowed value is 1000.
|
879
|
+
# @param [String] page_token
|
880
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
881
|
+
# this to retrieve the subsequent page.
|
882
|
+
# @param [String] fields
|
883
|
+
# Selector specifying which fields to include in a partial response.
|
884
|
+
# @param [String] quota_user
|
885
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
886
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
887
|
+
# @param [Google::Apis::RequestOptions] options
|
888
|
+
# Request-specific options
|
889
|
+
#
|
890
|
+
# @yield [result, err] Result & error if block supplied
|
891
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse] parsed result object
|
892
|
+
# @yieldparam err [StandardError] error object if request failed
|
893
|
+
#
|
894
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse]
|
895
|
+
#
|
896
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
897
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
898
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
899
|
+
def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
900
|
+
command = make_simple_command(:get, 'v2beta/{+parent}/controls', options)
|
901
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse::Representation
|
902
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse
|
903
|
+
command.params['parent'] = parent unless parent.nil?
|
904
|
+
command.query['filter'] = filter unless filter.nil?
|
905
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
906
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
907
|
+
command.query['fields'] = fields unless fields.nil?
|
908
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
909
|
+
execute_or_queue_command(command, &block)
|
910
|
+
end
|
911
|
+
|
912
|
+
# Updates a Control. Control cannot be set to a different oneof field, if so an
|
913
|
+
# INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
|
914
|
+
# NOT_FOUND error is returned.
|
915
|
+
# @param [String] name
|
916
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
917
|
+
# controls/*
|
918
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] google_cloud_retail_v2beta_control_object
|
919
|
+
# @param [String] update_mask
|
920
|
+
# Indicates which fields in the provided Control to update. The following are
|
921
|
+
# NOT supported: * Control.name If not set or empty, all supported fields are
|
922
|
+
# updated.
|
923
|
+
# @param [String] fields
|
924
|
+
# Selector specifying which fields to include in a partial response.
|
925
|
+
# @param [String] quota_user
|
926
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
927
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
928
|
+
# @param [Google::Apis::RequestOptions] options
|
929
|
+
# Request-specific options
|
930
|
+
#
|
931
|
+
# @yield [result, err] Result & error if block supplied
|
932
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
933
|
+
# @yieldparam err [StandardError] error object if request failed
|
934
|
+
#
|
935
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
936
|
+
#
|
937
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
938
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
939
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
940
|
+
def patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
941
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
942
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
943
|
+
command.request_object = google_cloud_retail_v2beta_control_object
|
944
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
945
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
946
|
+
command.params['name'] = name unless name.nil?
|
947
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
948
|
+
command.query['fields'] = fields unless fields.nil?
|
949
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
950
|
+
execute_or_queue_command(command, &block)
|
951
|
+
end
|
952
|
+
|
767
953
|
# Gets the latest state of a long-running operation. Clients can use this method
|
768
954
|
# to poll the operation result at intervals as recommended by the API service.
|
769
955
|
# @param [String] name
|
@@ -918,6 +1104,267 @@ module Google
|
|
918
1104
|
execute_or_queue_command(command, &block)
|
919
1105
|
end
|
920
1106
|
|
1107
|
+
# Enables a Control on the specified ServingConfig. The control is added in the
|
1108
|
+
# last position of the list of controls it belongs to (e.g. if it's a facet spec
|
1109
|
+
# control it will be applied in the last position of servingConfig.facetSpecIds)
|
1110
|
+
# Returns a ALREADY_EXISTS error if the control has already been applied.
|
1111
|
+
# Returns a FAILED_PRECONDITION error if the addition could exceed maximum
|
1112
|
+
# number of control allowed for that type of control.
|
1113
|
+
# @param [String] serving_config
|
1114
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1115
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1116
|
+
# serving_config_id`
|
1117
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest] google_cloud_retail_v2beta_add_control_request_object
|
1118
|
+
# @param [String] fields
|
1119
|
+
# Selector specifying which fields to include in a partial response.
|
1120
|
+
# @param [String] quota_user
|
1121
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1122
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1123
|
+
# @param [Google::Apis::RequestOptions] options
|
1124
|
+
# Request-specific options
|
1125
|
+
#
|
1126
|
+
# @yield [result, err] Result & error if block supplied
|
1127
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1128
|
+
# @yieldparam err [StandardError] error object if request failed
|
1129
|
+
#
|
1130
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1131
|
+
#
|
1132
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1133
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1134
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1135
|
+
def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1136
|
+
command = make_simple_command(:post, 'v2beta/{+servingConfig}:addControl', options)
|
1137
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest::Representation
|
1138
|
+
command.request_object = google_cloud_retail_v2beta_add_control_request_object
|
1139
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1140
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1141
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1142
|
+
command.query['fields'] = fields unless fields.nil?
|
1143
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1144
|
+
execute_or_queue_command(command, &block)
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
|
1148
|
+
# Catalog, otherwise a FAILED_PRECONDITION error is returned.
|
1149
|
+
# @param [String] parent
|
1150
|
+
# Required. Full resource name of parent. Format: projects/`project_number`/
|
1151
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1152
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] google_cloud_retail_v2beta_serving_config_object
|
1153
|
+
# @param [String] serving_config_id
|
1154
|
+
# Required. The ID to use for the ServingConfig, which will become the final
|
1155
|
+
# component of the ServingConfig's resource name. This value should be 4-63
|
1156
|
+
# characters, and valid characters are /a-z-_/.
|
1157
|
+
# @param [String] fields
|
1158
|
+
# Selector specifying which fields to include in a partial response.
|
1159
|
+
# @param [String] quota_user
|
1160
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1161
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1162
|
+
# @param [Google::Apis::RequestOptions] options
|
1163
|
+
# Request-specific options
|
1164
|
+
#
|
1165
|
+
# @yield [result, err] Result & error if block supplied
|
1166
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1167
|
+
# @yieldparam err [StandardError] error object if request failed
|
1168
|
+
#
|
1169
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1170
|
+
#
|
1171
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1172
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1173
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1174
|
+
def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1175
|
+
command = make_simple_command(:post, 'v2beta/{+parent}/servingConfigs', options)
|
1176
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1177
|
+
command.request_object = google_cloud_retail_v2beta_serving_config_object
|
1178
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1179
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1180
|
+
command.params['parent'] = parent unless parent.nil?
|
1181
|
+
command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil?
|
1182
|
+
command.query['fields'] = fields unless fields.nil?
|
1183
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1184
|
+
execute_or_queue_command(command, &block)
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
|
1188
|
+
# not exist.
|
1189
|
+
# @param [String] name
|
1190
|
+
# Required. The resource name of the ServingConfig to delete. Format: projects/`
|
1191
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1192
|
+
# serving_config_id`
|
1193
|
+
# @param [String] fields
|
1194
|
+
# Selector specifying which fields to include in a partial response.
|
1195
|
+
# @param [String] quota_user
|
1196
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1197
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1198
|
+
# @param [Google::Apis::RequestOptions] options
|
1199
|
+
# Request-specific options
|
1200
|
+
#
|
1201
|
+
# @yield [result, err] Result & error if block supplied
|
1202
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleProtobufEmpty] parsed result object
|
1203
|
+
# @yieldparam err [StandardError] error object if request failed
|
1204
|
+
#
|
1205
|
+
# @return [Google::Apis::RetailV2beta::GoogleProtobufEmpty]
|
1206
|
+
#
|
1207
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1208
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1209
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1210
|
+
def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1211
|
+
command = make_simple_command(:delete, 'v2beta/{+name}', options)
|
1212
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
|
1213
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
|
1214
|
+
command.params['name'] = name unless name.nil?
|
1215
|
+
command.query['fields'] = fields unless fields.nil?
|
1216
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1217
|
+
execute_or_queue_command(command, &block)
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
1221
|
+
# exist.
|
1222
|
+
# @param [String] name
|
1223
|
+
# Required. The resource name of the ServingConfig to get. Format: projects/`
|
1224
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1225
|
+
# serving_config_id`
|
1226
|
+
# @param [String] fields
|
1227
|
+
# Selector specifying which fields to include in a partial response.
|
1228
|
+
# @param [String] quota_user
|
1229
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1230
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1231
|
+
# @param [Google::Apis::RequestOptions] options
|
1232
|
+
# Request-specific options
|
1233
|
+
#
|
1234
|
+
# @yield [result, err] Result & error if block supplied
|
1235
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1236
|
+
# @yieldparam err [StandardError] error object if request failed
|
1237
|
+
#
|
1238
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1239
|
+
#
|
1240
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1241
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1242
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1243
|
+
def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1244
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
1245
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1246
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1247
|
+
command.params['name'] = name unless name.nil?
|
1248
|
+
command.query['fields'] = fields unless fields.nil?
|
1249
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1250
|
+
execute_or_queue_command(command, &block)
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Lists all ServingConfigs linked to this catalog.
|
1254
|
+
# @param [String] parent
|
1255
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
1256
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1257
|
+
# @param [Fixnum] page_size
|
1258
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
1259
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
1260
|
+
# @param [String] page_token
|
1261
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
1262
|
+
# Provide this to retrieve the subsequent page.
|
1263
|
+
# @param [String] fields
|
1264
|
+
# Selector specifying which fields to include in a partial response.
|
1265
|
+
# @param [String] quota_user
|
1266
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1267
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1268
|
+
# @param [Google::Apis::RequestOptions] options
|
1269
|
+
# Request-specific options
|
1270
|
+
#
|
1271
|
+
# @yield [result, err] Result & error if block supplied
|
1272
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse] parsed result object
|
1273
|
+
# @yieldparam err [StandardError] error object if request failed
|
1274
|
+
#
|
1275
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse]
|
1276
|
+
#
|
1277
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1278
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1279
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1280
|
+
def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1281
|
+
command = make_simple_command(:get, 'v2beta/{+parent}/servingConfigs', options)
|
1282
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse::Representation
|
1283
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse
|
1284
|
+
command.params['parent'] = parent unless parent.nil?
|
1285
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1286
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1287
|
+
command.query['fields'] = fields unless fields.nil?
|
1288
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1289
|
+
execute_or_queue_command(command, &block)
|
1290
|
+
end
|
1291
|
+
|
1292
|
+
# Updates a ServingConfig.
|
1293
|
+
# @param [String] name
|
1294
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
1295
|
+
# servingConfig/*
|
1296
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] google_cloud_retail_v2beta_serving_config_object
|
1297
|
+
# @param [String] update_mask
|
1298
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
1299
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
1300
|
+
# updated.
|
1301
|
+
# @param [String] fields
|
1302
|
+
# Selector specifying which fields to include in a partial response.
|
1303
|
+
# @param [String] quota_user
|
1304
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1305
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1306
|
+
# @param [Google::Apis::RequestOptions] options
|
1307
|
+
# Request-specific options
|
1308
|
+
#
|
1309
|
+
# @yield [result, err] Result & error if block supplied
|
1310
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1311
|
+
# @yieldparam err [StandardError] error object if request failed
|
1312
|
+
#
|
1313
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1314
|
+
#
|
1315
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1316
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1317
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1318
|
+
def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1319
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
1320
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1321
|
+
command.request_object = google_cloud_retail_v2beta_serving_config_object
|
1322
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1323
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1324
|
+
command.params['name'] = name unless name.nil?
|
1325
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1326
|
+
command.query['fields'] = fields unless fields.nil?
|
1327
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1328
|
+
execute_or_queue_command(command, &block)
|
1329
|
+
end
|
1330
|
+
|
1331
|
+
# Disables a Control on the specified ServingConfig. The control is removed from
|
1332
|
+
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1333
|
+
# the ServingConfig.
|
1334
|
+
# @param [String] serving_config
|
1335
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1336
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1337
|
+
# serving_config_id`
|
1338
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest] google_cloud_retail_v2beta_remove_control_request_object
|
1339
|
+
# @param [String] fields
|
1340
|
+
# Selector specifying which fields to include in a partial response.
|
1341
|
+
# @param [String] quota_user
|
1342
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1343
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1344
|
+
# @param [Google::Apis::RequestOptions] options
|
1345
|
+
# Request-specific options
|
1346
|
+
#
|
1347
|
+
# @yield [result, err] Result & error if block supplied
|
1348
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1349
|
+
# @yieldparam err [StandardError] error object if request failed
|
1350
|
+
#
|
1351
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1352
|
+
#
|
1353
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1354
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1355
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1356
|
+
def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1357
|
+
command = make_simple_command(:post, 'v2beta/{+servingConfig}:removeControl', options)
|
1358
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest::Representation
|
1359
|
+
command.request_object = google_cloud_retail_v2beta_remove_control_request_object
|
1360
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1361
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1362
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1363
|
+
command.query['fields'] = fields unless fields.nil?
|
1364
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1365
|
+
execute_or_queue_command(command, &block)
|
1366
|
+
end
|
1367
|
+
|
921
1368
|
# Writes a single user event from the browser. This uses a GET request to due to
|
922
1369
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
923
1370
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1190,6 +1637,83 @@ module Google
|
|
1190
1637
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1191
1638
|
execute_or_queue_command(command, &block)
|
1192
1639
|
end
|
1640
|
+
|
1641
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1642
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1643
|
+
# @param [String] name
|
1644
|
+
# The name of the operation resource.
|
1645
|
+
# @param [String] fields
|
1646
|
+
# Selector specifying which fields to include in a partial response.
|
1647
|
+
# @param [String] quota_user
|
1648
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1649
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1650
|
+
# @param [Google::Apis::RequestOptions] options
|
1651
|
+
# Request-specific options
|
1652
|
+
#
|
1653
|
+
# @yield [result, err] Result & error if block supplied
|
1654
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
|
1655
|
+
# @yieldparam err [StandardError] error object if request failed
|
1656
|
+
#
|
1657
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
|
1658
|
+
#
|
1659
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1660
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1661
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1662
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1663
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
1664
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
|
1665
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
|
1666
|
+
command.params['name'] = name unless name.nil?
|
1667
|
+
command.query['fields'] = fields unless fields.nil?
|
1668
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1669
|
+
execute_or_queue_command(command, &block)
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# Lists operations that match the specified filter in the request. If the server
|
1673
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
1674
|
+
# binding allows API services to override the binding to use different resource
|
1675
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
1676
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
1677
|
+
# service configuration. For backwards compatibility, the default name includes
|
1678
|
+
# the operations collection id, however overriding users must ensure the name
|
1679
|
+
# binding is the parent resource, without the operations collection id.
|
1680
|
+
# @param [String] name
|
1681
|
+
# The name of the operation's parent resource.
|
1682
|
+
# @param [String] filter
|
1683
|
+
# The standard list filter.
|
1684
|
+
# @param [Fixnum] page_size
|
1685
|
+
# The standard list page size.
|
1686
|
+
# @param [String] page_token
|
1687
|
+
# The standard list page token.
|
1688
|
+
# @param [String] fields
|
1689
|
+
# Selector specifying which fields to include in a partial response.
|
1690
|
+
# @param [String] quota_user
|
1691
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1692
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1693
|
+
# @param [Google::Apis::RequestOptions] options
|
1694
|
+
# Request-specific options
|
1695
|
+
#
|
1696
|
+
# @yield [result, err] Result & error if block supplied
|
1697
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse] parsed result object
|
1698
|
+
# @yieldparam err [StandardError] error object if request failed
|
1699
|
+
#
|
1700
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse]
|
1701
|
+
#
|
1702
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1703
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1704
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1705
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1706
|
+
command = make_simple_command(:get, 'v2beta/{+name}/operations', options)
|
1707
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation
|
1708
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
|
1709
|
+
command.params['name'] = name unless name.nil?
|
1710
|
+
command.query['filter'] = filter unless filter.nil?
|
1711
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1712
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1713
|
+
command.query['fields'] = fields unless fields.nil?
|
1714
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1715
|
+
execute_or_queue_command(command, &block)
|
1716
|
+
end
|
1193
1717
|
|
1194
1718
|
protected
|
1195
1719
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 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-
|
11
|
+
date: 2022-02-14 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_v2beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.28.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
|
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.
|
78
|
+
rubygems_version: 3.3.5
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Retail API V2beta
|