google-ads-googleads 7.0.0 → 8.0.0

data/lib/google/ads/google_ads/v6/services/user_location_view_service/credentials.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          module UserLocationViewService
+            # Credentials for the UserLocationViewService API.
+            class Credentials < ::Google::Auth::Credentials
+              self.env_vars = [
+                "GOOGLEADS_CREDENTIALS",
+                "GOOGLEADS_KEYFILE",
+                "GOOGLEADS_CREDENTIALS_JSON",
+                "GOOGLEADS_KEYFILE_JSON"
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v6/services/user_location_view_service/paths.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          module UserLocationViewService
+            # Path helper methods for the UserLocationViewService API.
+            module Paths
+              ##
+              # Create a fully-qualified UserLocationView resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `customers/{customer_id}/userLocationViews/{country_criterion_id}~{is_targeting_location}`
+              #
+              # @param customer_id [String]
+              # @param country_criterion_id [String]
+              # @param is_targeting_location [String]
+              #
+              # @return [::String]
+              def user_location_view_path customer_id:, country_criterion_id:, is_targeting_location:
+                raise ::ArgumentError, "customer_id cannot contain /" if customer_id.to_s.include? "/"
+                raise ::ArgumentError, "country_criterion_id cannot contain /" if country_criterion_id.to_s.include? "/"
+
+                "customers/#{customer_id}/userLocationViews/#{country_criterion_id}~#{is_targeting_location}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v6/services/user_location_view_service_pb.rb

@@ -0,0 +1,29 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/googleads/v6/services/user_location_view_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v6/resources/user_location_view_pb'
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/ads/googleads/v6/services/user_location_view_service.proto", :syntax => :proto3) do
+    add_message "google.ads.googleads.v6.services.GetUserLocationViewRequest" do
+      optional :resource_name, :string, 1
+    end
+  end
+end
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          GetUserLocationViewRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v6.services.GetUserLocationViewRequest").msgclass
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v6/services/user_location_view_service_services_pb.rb

@@ -0,0 +1,49 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/googleads/v6/services/user_location_view_service.proto for package 'Google.Ads.GoogleAds.V6.Services'
+# Original file comments:
+# Copyright 2020 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/ads/google_ads/v6/services/user_location_view_service_pb'
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          module UserLocationViewService
+            # Proto file describing the UserLocationView service.
+            #
+            # Service to manage user location views.
+            class Service
+
+              include GRPC::GenericService
+
+              self.marshal_class_method = :encode
+              self.unmarshal_class_method = :decode
+              self.service_name = 'google.ads.googleads.v6.services.UserLocationViewService'
+
+              # Returns the requested user location view in full detail.
+              rpc :GetUserLocationView, ::Google::Ads::GoogleAds::V6::Services::GetUserLocationViewRequest, ::Google::Ads::GoogleAds::V6::Resources::UserLocationView
+            end
+
+            Stub = Service.rpc_stub_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/ads/google_ads/v6/services/video_service.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/ads/google_ads/version"
+
+require "google/ads/google_ads/v6/services/video_service/credentials"
+require "google/ads/google_ads/v6/services/video_service/paths"
+require "google/ads/google_ads/v6/services/video_service/client"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          ##
+          # Service to manage videos.
+          #
+          # To load this service and instantiate a client:
+          #
+          #     require "google/ads/google_ads/v6/services/video_service"
+          #     client = ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.new
+          #
+          module VideoService
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "video_service", "helpers.rb"
+require "google/ads/google_ads/v6/services/video_service/helpers" if ::File.file? helper_path

data/lib/google/ads/google_ads/v6/services/video_service/client.rb

@@ -0,0 +1,372 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# require "google/ads/google_ads/error"
+require "google/ads/google_ads/v6/services/video_service_pb"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V6
+        module Services
+          module VideoService
+            ##
+            # Client for the VideoService service.
+            #
+            # Service to manage videos.
+            #
+            class Client
+              include Paths
+
+              # @private
+              attr_reader :video_service_stub
+
+              ##
+              # Configure the VideoService Client class.
+              #
+              # See {::Google::Ads::GoogleAds::V6::Services::VideoService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # ## Example
+              #
+              # To modify the configuration for all VideoService clients:
+              #
+              #     ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.configure do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  default_config = Client::Configuration.new
+
+                  default_config.timeout = 3600.0
+                  default_config.retry_policy = {
+                    initial_delay: 5.0,
+                    max_delay:     60.0,
+                    multiplier:    1.3,
+                    retry_codes:   [14, 4]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the VideoService 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 {Client.configure}.
+              #
+              # See {::Google::Ads::GoogleAds::V6::Services::VideoService::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # Create a new VideoService client object.
+              #
+              # ## Examples
+              #
+              # To create a new VideoService client with the default
+              # configuration:
+              #
+              #     client = ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.new
+              #
+              # To create a new VideoService client with a custom
+              # configuration:
+              #
+              #     client = ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.new do |config|
+              #       config.timeout = 10.0
+              #     end
+              #
+              # @yield [config] Configure the VideoService client.
+              # @yieldparam config [Client::Configuration]
+              #
+              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/ads/google_ads/v6/services/video_service_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
+                credentials ||= Credentials.default scope: @config.scope
+                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
+
+                @video_service_stub = ::Gapic::ServiceStub.new(
+                  ::Google::Ads::GoogleAds::V6::Services::VideoService::Stub,
+                  credentials:  credentials,
+                  endpoint:     @config.endpoint,
+                  channel_args: @config.channel_args,
+                  interceptors: @config.interceptors
+                )
+              end
+
+              # Service calls
+
+              ##
+              # Returns the requested video in full detail.
+              #
+              # @overload get_video(request, options = nil)
+              #   Pass arguments to `get_video` via a request object, either of type
+              #   {::Google::Ads::GoogleAds::V6::Services::GetVideoRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Ads::GoogleAds::V6::Services::GetVideoRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload get_video(resource_name: nil)
+              #   Pass arguments to `get_video` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param resource_name [::String]
+              #     Required. The resource name of the video to fetch.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Ads::GoogleAds::V6::Resources::Video]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Ads::GoogleAds::V6::Resources::Video]
+              #
+              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
+              #
+              def get_video request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V6::Services::GetVideoRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.get_video.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {
+                  "resource_name" => request.resource_name
+                }
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.get_video.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.get_video.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @video_service_stub.call_rpc :get_video, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+                # rescue GRPC::BadStatus => grpc_error
+                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
+              end
+
+              ##
+              # Configuration class for the VideoService API.
+              #
+              # This class represents the configuration for VideoService,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Ads::GoogleAds::V6::Services::VideoService::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # # Examples
+              #
+              # To modify the global config, setting the timeout for get_video
+              # to 20 seconds, and all remaining timeouts to 10 seconds:
+              #
+              #     ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.configure do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.get_video.timeout = 20.0
+              #     end
+              #
+              # To apply the above configuration only to a new client:
+              #
+              #     client = ::Google::Ads::GoogleAds::V6::Services::VideoService::Client.new do |config|
+              #       config.timeout = 10.0
+              #       config.rpcs.get_video.timeout = 20.0
+              #     end
+              #
+              # @!attribute [rw] endpoint
+              #   The hostname or hostname:port of the service endpoint.
+              #   Defaults to `"googleads.googleapis.com"`.
+              #   @return [::String]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] channel_args
+              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+              #   `GRPC::Core::Channel` object is provided as the credential.
+              #   @return [::Hash]
+              # @!attribute [rw] interceptors
+              #   An array of interceptors that are run before calls are executed.
+              #   @return [::Array<::GRPC::ClientInterceptor>]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional gRPC headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                config_attr :endpoint,      "googleads.googleapis.com", ::String
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+                config_attr :interceptors,  nil, ::Array, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the VideoService API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `get_video`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_video
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    get_video_config = parent_rpcs&.get_video if parent_rpcs&.respond_to? :get_video
+                    @get_video = ::Gapic::Config::Method.new get_video_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end