google-apis-retail_v2beta 0.25.0 → 0.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -764,6 +764,197 @@ module Google
|
|
764
764
|
execute_or_queue_command(command, &block)
|
765
765
|
end
|
766
766
|
|
767
|
+
# Creates a Control. If the Control to create already exists, an ALREADY_EXISTS
|
768
|
+
# error is returned.
|
769
|
+
# @param [String] parent
|
770
|
+
# Required. Full resource name of parent catalog. Format: projects/`
|
771
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`
|
772
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] google_cloud_retail_v2beta_control_object
|
773
|
+
# @param [String] control_id
|
774
|
+
# Required. The ID to use for the Control, which will become the final component
|
775
|
+
# of the Control's resource name. This value should be 4-63 characters, and
|
776
|
+
# valid characters are /a-z-_/.
|
777
|
+
# @param [String] fields
|
778
|
+
# Selector specifying which fields to include in a partial response.
|
779
|
+
# @param [String] quota_user
|
780
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
781
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
782
|
+
# @param [Google::Apis::RequestOptions] options
|
783
|
+
# Request-specific options
|
784
|
+
#
|
785
|
+
# @yield [result, err] Result & error if block supplied
|
786
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
787
|
+
# @yieldparam err [StandardError] error object if request failed
|
788
|
+
#
|
789
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
790
|
+
#
|
791
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
792
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
793
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
794
|
+
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)
|
795
|
+
command = make_simple_command(:post, 'v2beta/{+parent}/controls', options)
|
796
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
797
|
+
command.request_object = google_cloud_retail_v2beta_control_object
|
798
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
799
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
800
|
+
command.params['parent'] = parent unless parent.nil?
|
801
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
802
|
+
command.query['fields'] = fields unless fields.nil?
|
803
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
804
|
+
execute_or_queue_command(command, &block)
|
805
|
+
end
|
806
|
+
|
807
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
808
|
+
# is returned.
|
809
|
+
# @param [String] name
|
810
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
811
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
812
|
+
# control_id`
|
813
|
+
# @param [String] fields
|
814
|
+
# Selector specifying which fields to include in a partial response.
|
815
|
+
# @param [String] quota_user
|
816
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
817
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
818
|
+
# @param [Google::Apis::RequestOptions] options
|
819
|
+
# Request-specific options
|
820
|
+
#
|
821
|
+
# @yield [result, err] Result & error if block supplied
|
822
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleProtobufEmpty] parsed result object
|
823
|
+
# @yieldparam err [StandardError] error object if request failed
|
824
|
+
#
|
825
|
+
# @return [Google::Apis::RetailV2beta::GoogleProtobufEmpty]
|
826
|
+
#
|
827
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
828
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
829
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
830
|
+
def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
831
|
+
command = make_simple_command(:delete, 'v2beta/{+name}', options)
|
832
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
|
833
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
|
834
|
+
command.params['name'] = name unless name.nil?
|
835
|
+
command.query['fields'] = fields unless fields.nil?
|
836
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
837
|
+
execute_or_queue_command(command, &block)
|
838
|
+
end
|
839
|
+
|
840
|
+
# Gets a Control.
|
841
|
+
# @param [String] name
|
842
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
843
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
844
|
+
# control_id`
|
845
|
+
# @param [String] fields
|
846
|
+
# Selector specifying which fields to include in a partial response.
|
847
|
+
# @param [String] quota_user
|
848
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
849
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
850
|
+
# @param [Google::Apis::RequestOptions] options
|
851
|
+
# Request-specific options
|
852
|
+
#
|
853
|
+
# @yield [result, err] Result & error if block supplied
|
854
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
855
|
+
# @yieldparam err [StandardError] error object if request failed
|
856
|
+
#
|
857
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
858
|
+
#
|
859
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
860
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
861
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
862
|
+
def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
863
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
864
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
865
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
866
|
+
command.params['name'] = name unless name.nil?
|
867
|
+
command.query['fields'] = fields unless fields.nil?
|
868
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
869
|
+
execute_or_queue_command(command, &block)
|
870
|
+
end
|
871
|
+
|
872
|
+
# Lists all Controls linked to this catalog.
|
873
|
+
# @param [String] parent
|
874
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
875
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
876
|
+
# @param [String] filter
|
877
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
878
|
+
# all the products under the parent branch if filter is unset. * List controls
|
879
|
+
# that are used in a single ServingConfig: 'serving_config = "
|
880
|
+
# boosted_home_page_cvr"'
|
881
|
+
# @param [Fixnum] page_size
|
882
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
883
|
+
# Max allowed value is 1000.
|
884
|
+
# @param [String] page_token
|
885
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
886
|
+
# this to retrieve the subsequent page.
|
887
|
+
# @param [String] fields
|
888
|
+
# Selector specifying which fields to include in a partial response.
|
889
|
+
# @param [String] quota_user
|
890
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
891
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
892
|
+
# @param [Google::Apis::RequestOptions] options
|
893
|
+
# Request-specific options
|
894
|
+
#
|
895
|
+
# @yield [result, err] Result & error if block supplied
|
896
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse] parsed result object
|
897
|
+
# @yieldparam err [StandardError] error object if request failed
|
898
|
+
#
|
899
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse]
|
900
|
+
#
|
901
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
902
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
903
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
904
|
+
def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
905
|
+
command = make_simple_command(:get, 'v2beta/{+parent}/controls', options)
|
906
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse::Representation
|
907
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse
|
908
|
+
command.params['parent'] = parent unless parent.nil?
|
909
|
+
command.query['filter'] = filter unless filter.nil?
|
910
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
911
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
912
|
+
command.query['fields'] = fields unless fields.nil?
|
913
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
914
|
+
execute_or_queue_command(command, &block)
|
915
|
+
end
|
916
|
+
|
917
|
+
# Updates a Control. Control cannot be set to a different oneof field, if so an
|
918
|
+
# INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
|
919
|
+
# NOT_FOUND error is returned.
|
920
|
+
# @param [String] name
|
921
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
922
|
+
# controls/*
|
923
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] google_cloud_retail_v2beta_control_object
|
924
|
+
# @param [String] update_mask
|
925
|
+
# Indicates which fields in the provided Control to update. The following are
|
926
|
+
# NOT supported: * Control.name If not set or empty, all supported fields are
|
927
|
+
# updated.
|
928
|
+
# @param [String] fields
|
929
|
+
# Selector specifying which fields to include in a partial response.
|
930
|
+
# @param [String] quota_user
|
931
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
932
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
933
|
+
# @param [Google::Apis::RequestOptions] options
|
934
|
+
# Request-specific options
|
935
|
+
#
|
936
|
+
# @yield [result, err] Result & error if block supplied
|
937
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl] parsed result object
|
938
|
+
# @yieldparam err [StandardError] error object if request failed
|
939
|
+
#
|
940
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl]
|
941
|
+
#
|
942
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
943
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
944
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
945
|
+
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)
|
946
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
947
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
948
|
+
command.request_object = google_cloud_retail_v2beta_control_object
|
949
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation
|
950
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
|
951
|
+
command.params['name'] = name unless name.nil?
|
952
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
953
|
+
command.query['fields'] = fields unless fields.nil?
|
954
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
955
|
+
execute_or_queue_command(command, &block)
|
956
|
+
end
|
957
|
+
|
767
958
|
# Gets the latest state of a long-running operation. Clients can use this method
|
768
959
|
# to poll the operation result at intervals as recommended by the API service.
|
769
960
|
# @param [String] name
|
@@ -918,6 +1109,267 @@ module Google
|
|
918
1109
|
execute_or_queue_command(command, &block)
|
919
1110
|
end
|
920
1111
|
|
1112
|
+
# Enables a Control on the specified ServingConfig. The control is added in the
|
1113
|
+
# last position of the list of controls it belongs to (e.g. if it's a facet spec
|
1114
|
+
# control it will be applied in the last position of servingConfig.facetSpecIds)
|
1115
|
+
# Returns a ALREADY_EXISTS error if the control has already been applied.
|
1116
|
+
# Returns a FAILED_PRECONDITION error if the addition could exceed maximum
|
1117
|
+
# number of control allowed for that type of control.
|
1118
|
+
# @param [String] serving_config
|
1119
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1120
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1121
|
+
# serving_config_id`
|
1122
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest] google_cloud_retail_v2beta_add_control_request_object
|
1123
|
+
# @param [String] fields
|
1124
|
+
# Selector specifying which fields to include in a partial response.
|
1125
|
+
# @param [String] quota_user
|
1126
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1127
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1128
|
+
# @param [Google::Apis::RequestOptions] options
|
1129
|
+
# Request-specific options
|
1130
|
+
#
|
1131
|
+
# @yield [result, err] Result & error if block supplied
|
1132
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1133
|
+
# @yieldparam err [StandardError] error object if request failed
|
1134
|
+
#
|
1135
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1136
|
+
#
|
1137
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1138
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1139
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1140
|
+
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)
|
1141
|
+
command = make_simple_command(:post, 'v2beta/{+servingConfig}:addControl', options)
|
1142
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest::Representation
|
1143
|
+
command.request_object = google_cloud_retail_v2beta_add_control_request_object
|
1144
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1145
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1146
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1147
|
+
command.query['fields'] = fields unless fields.nil?
|
1148
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1149
|
+
execute_or_queue_command(command, &block)
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
|
1153
|
+
# Catalog, otherwise a FAILED_PRECONDITION error is returned.
|
1154
|
+
# @param [String] parent
|
1155
|
+
# Required. Full resource name of parent. Format: projects/`project_number`/
|
1156
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1157
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] google_cloud_retail_v2beta_serving_config_object
|
1158
|
+
# @param [String] serving_config_id
|
1159
|
+
# Required. The ID to use for the ServingConfig, which will become the final
|
1160
|
+
# component of the ServingConfig's resource name. This value should be 4-63
|
1161
|
+
# characters, and valid characters are /a-z-_/.
|
1162
|
+
# @param [String] fields
|
1163
|
+
# Selector specifying which fields to include in a partial response.
|
1164
|
+
# @param [String] quota_user
|
1165
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1166
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1167
|
+
# @param [Google::Apis::RequestOptions] options
|
1168
|
+
# Request-specific options
|
1169
|
+
#
|
1170
|
+
# @yield [result, err] Result & error if block supplied
|
1171
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1172
|
+
# @yieldparam err [StandardError] error object if request failed
|
1173
|
+
#
|
1174
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1175
|
+
#
|
1176
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1177
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1178
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1179
|
+
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)
|
1180
|
+
command = make_simple_command(:post, 'v2beta/{+parent}/servingConfigs', options)
|
1181
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1182
|
+
command.request_object = google_cloud_retail_v2beta_serving_config_object
|
1183
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1184
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1185
|
+
command.params['parent'] = parent unless parent.nil?
|
1186
|
+
command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil?
|
1187
|
+
command.query['fields'] = fields unless fields.nil?
|
1188
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1189
|
+
execute_or_queue_command(command, &block)
|
1190
|
+
end
|
1191
|
+
|
1192
|
+
# Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
|
1193
|
+
# not exist.
|
1194
|
+
# @param [String] name
|
1195
|
+
# Required. The resource name of the ServingConfig to delete. Format: projects/`
|
1196
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1197
|
+
# serving_config_id`
|
1198
|
+
# @param [String] fields
|
1199
|
+
# Selector specifying which fields to include in a partial response.
|
1200
|
+
# @param [String] quota_user
|
1201
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1202
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1203
|
+
# @param [Google::Apis::RequestOptions] options
|
1204
|
+
# Request-specific options
|
1205
|
+
#
|
1206
|
+
# @yield [result, err] Result & error if block supplied
|
1207
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleProtobufEmpty] parsed result object
|
1208
|
+
# @yieldparam err [StandardError] error object if request failed
|
1209
|
+
#
|
1210
|
+
# @return [Google::Apis::RetailV2beta::GoogleProtobufEmpty]
|
1211
|
+
#
|
1212
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1213
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1214
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1215
|
+
def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1216
|
+
command = make_simple_command(:delete, 'v2beta/{+name}', options)
|
1217
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
|
1218
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
|
1219
|
+
command.params['name'] = name unless name.nil?
|
1220
|
+
command.query['fields'] = fields unless fields.nil?
|
1221
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1222
|
+
execute_or_queue_command(command, &block)
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
1226
|
+
# exist.
|
1227
|
+
# @param [String] name
|
1228
|
+
# Required. The resource name of the ServingConfig to get. Format: projects/`
|
1229
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1230
|
+
# serving_config_id`
|
1231
|
+
# @param [String] fields
|
1232
|
+
# Selector specifying which fields to include in a partial response.
|
1233
|
+
# @param [String] quota_user
|
1234
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1235
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1236
|
+
# @param [Google::Apis::RequestOptions] options
|
1237
|
+
# Request-specific options
|
1238
|
+
#
|
1239
|
+
# @yield [result, err] Result & error if block supplied
|
1240
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1241
|
+
# @yieldparam err [StandardError] error object if request failed
|
1242
|
+
#
|
1243
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1244
|
+
#
|
1245
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1246
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1247
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1248
|
+
def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1249
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
1250
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1251
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1252
|
+
command.params['name'] = name unless name.nil?
|
1253
|
+
command.query['fields'] = fields unless fields.nil?
|
1254
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1255
|
+
execute_or_queue_command(command, &block)
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
# Lists all ServingConfigs linked to this catalog.
|
1259
|
+
# @param [String] parent
|
1260
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
1261
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1262
|
+
# @param [Fixnum] page_size
|
1263
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
1264
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
1265
|
+
# @param [String] page_token
|
1266
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
1267
|
+
# Provide this to retrieve the subsequent page.
|
1268
|
+
# @param [String] fields
|
1269
|
+
# Selector specifying which fields to include in a partial response.
|
1270
|
+
# @param [String] quota_user
|
1271
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1272
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1273
|
+
# @param [Google::Apis::RequestOptions] options
|
1274
|
+
# Request-specific options
|
1275
|
+
#
|
1276
|
+
# @yield [result, err] Result & error if block supplied
|
1277
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse] parsed result object
|
1278
|
+
# @yieldparam err [StandardError] error object if request failed
|
1279
|
+
#
|
1280
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse]
|
1281
|
+
#
|
1282
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1283
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1284
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1285
|
+
def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1286
|
+
command = make_simple_command(:get, 'v2beta/{+parent}/servingConfigs', options)
|
1287
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse::Representation
|
1288
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse
|
1289
|
+
command.params['parent'] = parent unless parent.nil?
|
1290
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1291
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1292
|
+
command.query['fields'] = fields unless fields.nil?
|
1293
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1294
|
+
execute_or_queue_command(command, &block)
|
1295
|
+
end
|
1296
|
+
|
1297
|
+
# Updates a ServingConfig.
|
1298
|
+
# @param [String] name
|
1299
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
1300
|
+
# servingConfig/*
|
1301
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] google_cloud_retail_v2beta_serving_config_object
|
1302
|
+
# @param [String] update_mask
|
1303
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
1304
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
1305
|
+
# updated.
|
1306
|
+
# @param [String] fields
|
1307
|
+
# Selector specifying which fields to include in a partial response.
|
1308
|
+
# @param [String] quota_user
|
1309
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1310
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1311
|
+
# @param [Google::Apis::RequestOptions] options
|
1312
|
+
# Request-specific options
|
1313
|
+
#
|
1314
|
+
# @yield [result, err] Result & error if block supplied
|
1315
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1316
|
+
# @yieldparam err [StandardError] error object if request failed
|
1317
|
+
#
|
1318
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1319
|
+
#
|
1320
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1321
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1322
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1323
|
+
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)
|
1324
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
1325
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1326
|
+
command.request_object = google_cloud_retail_v2beta_serving_config_object
|
1327
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1328
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1329
|
+
command.params['name'] = name unless name.nil?
|
1330
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1331
|
+
command.query['fields'] = fields unless fields.nil?
|
1332
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1333
|
+
execute_or_queue_command(command, &block)
|
1334
|
+
end
|
1335
|
+
|
1336
|
+
# Disables a Control on the specified ServingConfig. The control is removed from
|
1337
|
+
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1338
|
+
# the ServingConfig.
|
1339
|
+
# @param [String] serving_config
|
1340
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1341
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1342
|
+
# serving_config_id`
|
1343
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest] google_cloud_retail_v2beta_remove_control_request_object
|
1344
|
+
# @param [String] fields
|
1345
|
+
# Selector specifying which fields to include in a partial response.
|
1346
|
+
# @param [String] quota_user
|
1347
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1348
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1349
|
+
# @param [Google::Apis::RequestOptions] options
|
1350
|
+
# Request-specific options
|
1351
|
+
#
|
1352
|
+
# @yield [result, err] Result & error if block supplied
|
1353
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig] parsed result object
|
1354
|
+
# @yieldparam err [StandardError] error object if request failed
|
1355
|
+
#
|
1356
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig]
|
1357
|
+
#
|
1358
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1359
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1360
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1361
|
+
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)
|
1362
|
+
command = make_simple_command(:post, 'v2beta/{+servingConfig}:removeControl', options)
|
1363
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest::Representation
|
1364
|
+
command.request_object = google_cloud_retail_v2beta_remove_control_request_object
|
1365
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation
|
1366
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
|
1367
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1368
|
+
command.query['fields'] = fields unless fields.nil?
|
1369
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1370
|
+
execute_or_queue_command(command, &block)
|
1371
|
+
end
|
1372
|
+
|
921
1373
|
# Writes a single user event from the browser. This uses a GET request to due to
|
922
1374
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
923
1375
|
# 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_v2beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.26.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-
|
11
|
+
date: 2022-01-31 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.26.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: []
|