Class: Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client
- Inherits:
-
Object
- Object
- Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Client
- Includes:
- Paths
- Defined in:
- lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb
Overview
Client for the ConversionSourcesService service.
Service for managing conversion sources for a merchant account.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversionSourcesService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversionSourcesService Client instance.
-
#create_conversion_source(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Creates a new conversion source.
-
#delete_conversion_source(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Archives an existing conversion source.
-
#get_conversion_source(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Fetches a conversion source.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ConversionSourcesService client object.
-
#list_conversion_sources(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource>
Retrieves the list of conversion sources the caller has access to.
-
#undelete_conversion_source(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Re-enables an archived conversion source.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_conversion_source(request, options = nil) {|response, operation| ... } ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Updates information of an existing conversion source.
Methods included from Paths
#account_path, #conversion_source_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ConversionSourcesService client object.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 127 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/shopping/merchant/conversions/v1beta/conversionsources_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @conversion_sources_service_stub = ::Gapic::ServiceStub.new( ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSourcesService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversionSourcesService Client class.
See Configuration for a description of the configuration fields.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 60 def self.configure @configure ||= begin namespace = ["Google", "Shopping", "Merchant", "Conversions", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversionSourcesService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
97 98 99 100 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 97 def configure yield @config if block_given? @config end |
#create_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #create_conversion_source(parent: nil, conversion_source: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Creates a new conversion source.
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 217 def create_conversion_source request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::CreateConversionSourceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_conversion_source..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_conversion_source.timeout, metadata: , retry_policy: @config.rpcs.create_conversion_source.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :create_conversion_source, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_conversion_source(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversion_source(name: nil) ⇒ ::Google::Protobuf::Empty
Archives an existing conversion source. If the conversion source is a Merchant Center Destination, it will be recoverable for 30 days. If the conversion source is a Google Analytics Link, it will be deleted immediately and can be restored by creating a new one.
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 395 def delete_conversion_source request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::DeleteConversionSourceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_conversion_source..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_conversion_source.timeout, metadata: , retry_policy: @config.rpcs.delete_conversion_source.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :delete_conversion_source, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #get_conversion_source(name: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Fetches a conversion source.
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 568 def get_conversion_source request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::GetConversionSourceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_conversion_source..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_conversion_source.timeout, metadata: , retry_policy: @config.rpcs.get_conversion_source.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :get_conversion_source, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_conversion_sources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource> #list_conversion_sources(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource>
Retrieves the list of conversion sources the caller has access to.
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 668 def list_conversion_sources request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::ListConversionSourcesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_conversion_sources..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_conversion_sources.timeout, metadata: , retry_policy: @config.rpcs.list_conversion_sources.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :list_conversion_sources, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @conversion_sources_service_stub, :list_conversion_sources, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#undelete_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #undelete_conversion_source(name: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 482 def undelete_conversion_source request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::UndeleteConversionSourceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.undelete_conversion_source..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.undelete_conversion_source.timeout, metadata: , retry_policy: @config.rpcs.undelete_conversion_source.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :undelete_conversion_source, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
107 108 109 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 107 def universe_domain @conversion_sources_service_stub.universe_domain end |
#update_conversion_source(request, options = nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource #update_conversion_source(conversion_source: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource
Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/google/shopping/merchant/conversions/v1beta/conversion_sources_service/client.rb', line 306 def update_conversion_source request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Conversions::V1beta::UpdateConversionSourceRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_conversion_source..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Shopping::Merchant::Conversions::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversion_source&.name header_params["conversion_source.name"] = request.conversion_source.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_conversion_source.timeout, metadata: , retry_policy: @config.rpcs.update_conversion_source.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversion_sources_service_stub.call_rpc :update_conversion_source, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |