google-ads-googleads 5.1.0 → 6.0.0

data/lib/google/ads/google_ads/v4/services/batch_job_service_client.rb

@@ -0,0 +1,500 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/ads/google_ads/v4/services/batch_job_service.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+require "google/gax/operation"
+require "google/longrunning/operations_client"
+
+require "google/ads/google_ads/v4/services/batch_job_service_pb"
+require "google/ads/google_ads/v4/services/credentials"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V4
+        module Services
+          # Service to manage batch jobs.
+          #
+          # @!attribute [r] batch_job_service_stub
+          #   @return [Google::Ads::GoogleAds::V4::Services::BatchJobService::Stub]
+          class BatchJobServiceClient
+            attr_reader :batch_job_service_stub
+
+            # The default address of the service.
+            SERVICE_ADDRESS = "googleads.googleapis.com".freeze
+
+            # The default port of the service.
+            DEFAULT_SERVICE_PORT = 443
+
+            # The default set of gRPC interceptors.
+            GRPC_INTERCEPTORS = []
+
+            DEFAULT_TIMEOUT = 30
+
+            PAGE_DESCRIPTORS = {
+              "list_batch_job_results" => Google::Gax::PageDescriptor.new(
+                "page_token",
+                "next_page_token",
+                "results")
+            }.freeze
+
+            private_constant :PAGE_DESCRIPTORS
+
+            # The scopes needed to make gRPC calls to all of the methods defined in
+            # this service.
+            ALL_SCOPES = [
+            ].freeze
+
+            class OperationsClient < Google::Longrunning::OperationsClient
+              self::SERVICE_ADDRESS = BatchJobServiceClient::SERVICE_ADDRESS
+              self::GRPC_INTERCEPTORS = BatchJobServiceClient::GRPC_INTERCEPTORS
+            end
+
+            BATCH_JOB_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "customers/{customer}/batchJobs/{batch_job}"
+            )
+
+            private_constant :BATCH_JOB_PATH_TEMPLATE
+
+            # Returns a fully-qualified batch_job resource name string.
+            # @param customer [String]
+            # @param batch_job [String]
+            # @return [String]
+            def self.batch_job_path customer, batch_job
+              BATCH_JOB_PATH_TEMPLATE.render(
+                :"customer" => customer,
+                :"batch_job" => batch_job
+              )
+            end
+
+            # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+            #   Provides the means for authenticating requests made by the client. This parameter can
+            #   be many types.
+            #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+            #   authenticating requests made by this client.
+            #   A `String` will be treated as the path to the keyfile to be used for the construction of
+            #   credentials for this client.
+            #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+            #   credentials for this client.
+            #   A `GRPC::Core::Channel` will be used to make calls through.
+            #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+            #   should already be composed with a `GRPC::Core::CallCredentials` object.
+            #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+            #   metadata for requests, generally, to give OAuth credentials.
+            # @param scopes [Array<String>]
+            #   The OAuth scopes for this service. This parameter is ignored if
+            #   an updater_proc is supplied.
+            # @param client_config [Hash]
+            #   A Hash for call options for each method. See
+            #   Google::Gax#construct_settings for the structure of
+            #   this data. Falls back to the default config if not specified
+            #   or the specified config is missing data points.
+            # @param timeout [Numeric]
+            #   The default timeout, in seconds, for calls made through this client.
+            # @param metadata [Hash]
+            #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+            # @param exception_transformer [Proc]
+            #   An optional proc that intercepts any exceptions raised during an API call to inject
+            #   custom error handling.
+            def initialize \
+                credentials: nil,
+                scopes: ALL_SCOPES,
+                client_config: {},
+                timeout: DEFAULT_TIMEOUT,
+                metadata: nil,
+                exception_transformer: nil,
+                lib_name: nil,
+                lib_version: ""
+              # 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 "google/gax/grpc"
+              require "google/ads/google_ads/v4/services/batch_job_service_services_pb"
+
+              credentials ||= Google::Ads::GoogleAds::V4::Services::Credentials.default
+
+              @operations_client = OperationsClient.new(
+                credentials: credentials,
+                scopes: scopes,
+                client_config: client_config,
+                timeout: timeout,
+                lib_name: lib_name,
+                lib_version: lib_version,
+              )
+
+              if credentials.is_a?(String) || credentials.is_a?(Hash)
+                updater_proc = Google::Ads::GoogleAds::V4::Services::Credentials.new(credentials).updater_proc
+              end
+              if credentials.is_a?(GRPC::Core::Channel)
+                channel = credentials
+              end
+              if credentials.is_a?(GRPC::Core::ChannelCredentials)
+                chan_creds = credentials
+              end
+              if credentials.is_a?(Proc)
+                updater_proc = credentials
+              end
+              if credentials.is_a?(Google::Auth::Credentials)
+                updater_proc = credentials.updater_proc
+              end
+
+              package_version = Gem.loaded_specs['google-ads-googleads'].version.version
+
+              google_api_client = "gl-ruby/#{RUBY_VERSION}"
+              google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+              google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+              google_api_client << " grpc/#{GRPC::VERSION}"
+              google_api_client.freeze
+
+              headers = { :"x-goog-api-client" => google_api_client }
+              headers.merge!(metadata) unless metadata.nil?
+              client_config_file = Pathname.new(__dir__).join(
+                "batch_job_service_client_config.json"
+              )
+              defaults = client_config_file.open do |f|
+                Google::Gax.construct_settings(
+                  "google.ads.googleads.v4.services.BatchJobService",
+                  JSON.parse(f.read),
+                  client_config,
+                  Google::Gax::Grpc::STATUS_CODE_NAMES,
+                  timeout,
+                  page_descriptors: PAGE_DESCRIPTORS,
+                  errors: Google::Gax::Grpc::API_ERRORS,
+                  metadata: headers
+                )
+              end
+
+              # Allow overriding the service path/port in subclasses.
+              service_path = self.class::SERVICE_ADDRESS
+              port = self.class::DEFAULT_SERVICE_PORT
+              interceptors = self.class::GRPC_INTERCEPTORS
+              @batch_job_service_stub = Google::Gax::Grpc.create_stub(
+                service_path,
+                port,
+                chan_creds: chan_creds,
+                channel: channel,
+                updater_proc: updater_proc,
+                scopes: scopes,
+                interceptors: interceptors,
+                &Google::Ads::GoogleAds::V4::Services::BatchJobService::Stub.method(:new)
+              )
+
+              @mutate_batch_job = Google::Gax.create_api_call(
+                @batch_job_service_stub.method(:mutate_batch_job),
+                defaults["mutate_batch_job"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'customer_id' => request.customer_id}
+                end
+              )
+              @get_batch_job = Google::Gax.create_api_call(
+                @batch_job_service_stub.method(:get_batch_job),
+                defaults["get_batch_job"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'resource_name' => request.resource_name}
+                end
+              )
+              @list_batch_job_results = Google::Gax.create_api_call(
+                @batch_job_service_stub.method(:list_batch_job_results),
+                defaults["list_batch_job_results"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'resource_name' => request.resource_name}
+                end
+              )
+              @run_batch_job = Google::Gax.create_api_call(
+                @batch_job_service_stub.method(:run_batch_job),
+                defaults["run_batch_job"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'resource_name' => request.resource_name}
+                end
+              )
+              @add_batch_job_operations = Google::Gax.create_api_call(
+                @batch_job_service_stub.method(:add_batch_job_operations),
+                defaults["add_batch_job_operations"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'resource_name' => request.resource_name}
+                end
+              )
+            end
+
+            # Service calls
+
+            # Mutates a batch job.
+            #
+            # @param customer_id [String]
+            #   Required. The ID of the customer for which to create a batch job.
+            # @param operation [Google::Ads::GoogleAds::V4::Services::BatchJobOperation | Hash]
+            #   Required. The operation to perform on an individual batch job.
+            #   A hash of the same form as `Google::Ads::GoogleAds::V4::Services::BatchJobOperation`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Ads::GoogleAds::V4::Services::MutateBatchJobResponse]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::GoogleAds::V4::Services::MutateBatchJobResponse]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   batch_job_client = Google::Ads::GoogleAds::BatchJob.new(version: :v4)
+            #
+            #   # TODO: Initialize `customer_id`:
+            #   customer_id = ''
+            #
+            #   # TODO: Initialize `operation`:
+            #   operation = {}
+            #   response = batch_job_client.mutate_batch_job(customer_id, operation)
+
+            def mutate_batch_job \
+                customer_id,
+                operation,
+                options: nil,
+                &block
+              req = {
+                customer_id: customer_id,
+                operation: operation
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V4::Services::MutateBatchJobRequest)
+              @mutate_batch_job.call(req, options, &block)
+            end
+
+            # Returns the batch job.
+            #
+            # @param resource_name [String]
+            #   Required. The resource name of the batch job to get.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Ads::GoogleAds::V4::Resources::BatchJob]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::GoogleAds::V4::Resources::BatchJob]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   batch_job_client = Google::Ads::GoogleAds::BatchJob.new(version: :v4)
+            #   formatted_resource_name = Google::Ads::GoogleAds::V4::Services::BatchJobServiceClient.batch_job_path("[CUSTOMER]", "[BATCH_JOB]")
+            #   response = batch_job_client.get_batch_job(formatted_resource_name)
+
+            def get_batch_job \
+                resource_name,
+                options: nil,
+                &block
+              req = {
+                resource_name: resource_name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V4::Services::GetBatchJobRequest)
+              @get_batch_job.call(req, options, &block)
+            end
+
+            # Returns the results of the batch job. The job must be done.
+            # Supports standard list paging.
+            #
+            # @param resource_name [String]
+            #   Required. The resource name of the batch job whose results are being listed.
+            # @param page_size [Integer]
+            #   The maximum number of resources contained in the underlying API
+            #   response. If page streaming is performed per-resource, this
+            #   parameter does not affect the return value. If page streaming is
+            #   performed per-page, this determines the maximum number of
+            #   resources in a page.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Gax::PagedEnumerable<Google::Ads::GoogleAds::V4::Services::BatchJobResult>]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Gax::PagedEnumerable<Google::Ads::GoogleAds::V4::Services::BatchJobResult>]
+            #   An enumerable of Google::Ads::GoogleAds::V4::Services::BatchJobResult instances.
+            #   See Google::Gax::PagedEnumerable documentation for other
+            #   operations such as per-page iteration or access to the response
+            #   object.
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   batch_job_client = Google::Ads::GoogleAds::BatchJob.new(version: :v4)
+            #   formatted_resource_name = Google::Ads::GoogleAds::V4::Services::BatchJobServiceClient.batch_job_path("[CUSTOMER]", "[BATCH_JOB]")
+            #
+            #   # Iterate over all results.
+            #   batch_job_client.list_batch_job_results(formatted_resource_name).each do |element|
+            #     # Process element.
+            #   end
+            #
+            #   # Or iterate over results one page at a time.
+            #   batch_job_client.list_batch_job_results(formatted_resource_name).each_page do |page|
+            #     # Process each page at a time.
+            #     page.each do |element|
+            #       # Process element.
+            #     end
+            #   end
+
+            def list_batch_job_results \
+                resource_name,
+                page_size: nil,
+                options: nil,
+                &block
+              req = {
+                resource_name: resource_name,
+                page_size: page_size
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V4::Services::ListBatchJobResultsRequest)
+              @list_batch_job_results.call(req, options, &block)
+            end
+
+            # Runs the batch job.
+            #
+            # The Operation.metadata field type is BatchJobMetadata. When finished, the
+            # long running operation will not contain errors or a response. Instead, use
+            # ListBatchJobResults to get the results of the job.
+            #
+            # @param resource_name [String]
+            #   Required. The resource name of the BatchJob to run.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @return [Google::Gax::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   batch_job_client = Google::Ads::GoogleAds::BatchJob.new(version: :v4)
+            #   formatted_resource_name = Google::Ads::GoogleAds::V4::Services::BatchJobServiceClient.batch_job_path("[CUSTOMER]", "[BATCH_JOB]")
+            #
+            #   # Register a callback during the method call.
+            #   operation = batch_job_client.run_batch_job(formatted_resource_name) do |op|
+            #     raise op.results.message if op.error?
+            #     op_results = op.results
+            #     # Process the results.
+            #
+            #     metadata = op.metadata
+            #     # Process the metadata.
+            #   end
+            #
+            #   # Or use the return value to register a callback.
+            #   operation.on_done do |op|
+            #     raise op.results.message if op.error?
+            #     op_results = op.results
+            #     # Process the results.
+            #
+            #     metadata = op.metadata
+            #     # Process the metadata.
+            #   end
+            #
+            #   # Manually reload the operation.
+            #   operation.reload!
+            #
+            #   # Or block until the operation completes, triggering callbacks on
+            #   # completion.
+            #   operation.wait_until_done!
+
+            def run_batch_job \
+                resource_name,
+                options: nil
+              req = {
+                resource_name: resource_name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V4::Services::RunBatchJobRequest)
+              operation = Google::Gax::Operation.new(
+                @run_batch_job.call(req, options),
+                @operations_client,
+                Google::Protobuf::Empty,
+                Google::Ads::GoogleAds::V4::Resources::BatchJob::BatchJobMetadata,
+                call_options: options
+              )
+              operation.on_done { |operation| yield(operation) } if block_given?
+              operation
+            end
+
+            # Add operations to the batch job.
+            #
+            # @param resource_name [String]
+            #   Required. The resource name of the batch job.
+            # @param sequence_token [String]
+            #   A token used to enforce sequencing.
+            #
+            #   The first AddBatchJobOperations request for a batch job should not set
+            #   sequence_token. Subsequent requests must set sequence_token to the value of
+            #   next_sequence_token received in the previous AddBatchJobOperations
+            #   response.
+            # @param mutate_operations [Array<Google::Ads::GoogleAds::V4::Services::MutateOperation | Hash>]
+            #   Required. The list of mutates being added.
+            #
+            #   Operations can use negative integers as temp ids to signify dependencies
+            #   between entities created in this batch job. For example, a customer with
+            #   id = 1234 can create a campaign and an ad group in that same campaign by
+            #   creating a campaign in the first operation with the resource name
+            #   explicitly set to "customers/1234/campaigns/-1", and creating an ad group
+            #   in the second operation with the campaign field also set to
+            #   "customers/1234/campaigns/-1".
+            #   A hash of the same form as `Google::Ads::GoogleAds::V4::Services::MutateOperation`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Ads::GoogleAds::V4::Services::AddBatchJobOperationsResponse]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::GoogleAds::V4::Services::AddBatchJobOperationsResponse]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   batch_job_client = Google::Ads::GoogleAds::BatchJob.new(version: :v4)
+            #   formatted_resource_name = Google::Ads::GoogleAds::V4::Services::BatchJobServiceClient.batch_job_path("[CUSTOMER]", "[BATCH_JOB]")
+            #
+            #   # TODO: Initialize `sequence_token`:
+            #   sequence_token = ''
+            #
+            #   # TODO: Initialize `mutate_operations`:
+            #   mutate_operations = []
+            #   response = batch_job_client.add_batch_job_operations(formatted_resource_name, sequence_token, mutate_operations)
+
+            def add_batch_job_operations \
+                resource_name,
+                sequence_token,
+                mutate_operations,
+                options: nil,
+                &block
+              req = {
+                resource_name: resource_name,
+                sequence_token: sequence_token,
+                mutate_operations: mutate_operations
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V4::Services::AddBatchJobOperationsRequest)
+              @add_batch_job_operations.call(req, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end