google-ads-googleads 1.1.1 → 2.0.0

data/lib/google/ads/google_ads/v0/services/keyword_plan_ad_group_service_services_pb.rb

@@ -1,43 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: google/ads/google_ads/v0/services/keyword_plan_ad_group_service.proto for package 'Google::Ads::GoogleAds::V0::Services'
-# Original file comments:
-# Copyright 2018 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/v0/services/keyword_plan_ad_group_service_pb'
-
-module Google::Ads::GoogleAds::V0::Services
-  module KeywordPlanAdGroupService
-    # Service to manage Keyword Plan ad groups.
-    class Service
-
-      include GRPC::GenericService
-
-      self.marshal_class_method = :encode
-      self.unmarshal_class_method = :decode
-      self.service_name = 'google.ads.googleads.v0.services.KeywordPlanAdGroupService'
-
-      # Returns the requested Keyword Plan ad group in full detail.
-      rpc :GetKeywordPlanAdGroup, GetKeywordPlanAdGroupRequest, Google::Ads::GoogleAds::V0::Resources::KeywordPlanAdGroup
-      # Creates, updates, or removes Keyword Plan ad groups. Operation statuses are
-      # returned.
-      rpc :MutateKeywordPlanAdGroups, MutateKeywordPlanAdGroupsRequest, MutateKeywordPlanAdGroupsResponse
-    end
-
-    Stub = Service.rpc_stub_class
-  end
-end

data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_client.rb

@@ -1,280 +0,0 @@
-# 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/v0/services/keyword_plan_campaign_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/ads/google_ads/v0/services/keyword_plan_campaign_service_pb"
-require "google/ads/google_ads/v0/services/credentials"
-
-module Google
-  module Ads
-    module GoogleAds
-      module V0
-        module Services
-          # Service to manage Keyword Plan campaigns.
-          #
-          # @!attribute [r] keyword_plan_campaign_service_stub
-          #   @return [Google::Ads::GoogleAds::V0::Services::KeywordPlanCampaignService::Stub]
-          class KeywordPlanCampaignServiceClient
-            attr_reader :keyword_plan_campaign_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
-
-            # The scopes needed to make gRPC calls to all of the methods defined in
-            # this service.
-            ALL_SCOPES = [
-            ].freeze
-
-
-            KEYWORD_PLAN_CAMPAIGN_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-              "customers/{customer}/keywordPlanCampaigns/{keyword_plan_campaign}"
-            )
-
-            private_constant :KEYWORD_PLAN_CAMPAIGN_PATH_TEMPLATE
-
-            # Returns a fully-qualified keyword_plan_campaign resource name string.
-            # @param customer [String]
-            # @param keyword_plan_campaign [String]
-            # @return [String]
-            def self.keyword_plan_campaign_path customer, keyword_plan_campaign
-              KEYWORD_PLAN_CAMPAIGN_PATH_TEMPLATE.render(
-                :"customer" => customer,
-                :"keyword_plan_campaign" => keyword_plan_campaign
-              )
-            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/v0/services/keyword_plan_campaign_service_services_pb"
-
-              credentials ||= Google::Ads::GoogleAds::V0::Services::Credentials.default
-
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
-                updater_proc = Google::Ads::GoogleAds::V0::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(
-                "keyword_plan_campaign_service_client_config.json"
-              )
-              defaults = client_config_file.open do |f|
-                Google::Gax.construct_settings(
-                  "google.ads.googleads.v0.services.KeywordPlanCampaignService",
-                  JSON.parse(f.read),
-                  client_config,
-                  Google::Gax::Grpc::STATUS_CODE_NAMES,
-                  timeout,
-                  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
-              @keyword_plan_campaign_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::V0::Services::KeywordPlanCampaignService::Stub.method(:new)
-              )
-
-              @get_keyword_plan_campaign = Google::Gax.create_api_call(
-                @keyword_plan_campaign_service_stub.method(:get_keyword_plan_campaign),
-                defaults["get_keyword_plan_campaign"],
-                exception_transformer: exception_transformer
-              )
-              @mutate_keyword_plan_campaigns = Google::Gax.create_api_call(
-                @keyword_plan_campaign_service_stub.method(:mutate_keyword_plan_campaigns),
-                defaults["mutate_keyword_plan_campaigns"],
-                exception_transformer: exception_transformer
-              )
-            end
-
-            # Service calls
-
-            # Returns the requested Keyword Plan campaign in full detail.
-            #
-            # @param resource_name [String]
-            #   The resource name of the Keyword Plan campaign to fetch.
-            # @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::V0::Resources::KeywordPlanCampaign]
-            # @yieldparam operation [GRPC::ActiveCall::Operation]
-            # @return [Google::Ads::GoogleAds::V0::Resources::KeywordPlanCampaign]
-            # @raise [Google::Gax::GaxError] if the RPC is aborted.
-            # @example
-            #   require "google/ads/google_ads"
-            #
-            #   keyword_plan_campaign_service_client = Google::Ads::GoogleAds::KeywordPlanCampaign.new(version: :v0)
-            #   formatted_resource_name = Google::Ads::GoogleAds::V0::Services::KeywordPlanCampaignServiceClient.keyword_plan_campaign_path("[CUSTOMER]", "[KEYWORD_PLAN_CAMPAIGN]")
-            #   response = keyword_plan_campaign_service_client.get_keyword_plan_campaign(formatted_resource_name)
-
-            def get_keyword_plan_campaign \
-                resource_name,
-                options: nil,
-                &block
-              req = {
-                resource_name: resource_name
-              }.delete_if { |_, v| v.nil? }
-              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V0::Services::GetKeywordPlanCampaignRequest)
-              @get_keyword_plan_campaign.call(req, options, &block)
-            end
-
-            # Creates, updates, or removes Keyword Plan campaigns. Operation statuses are
-            # returned.
-            #
-            # @param customer_id [String]
-            #   The ID of the customer whose Keyword Plan campaigns are being modified.
-            # @param operations [Array<Google::Ads::GoogleAds::V0::Services::KeywordPlanCampaignOperation | Hash>]
-            #   The list of operations to perform on individual Keyword Plan campaigns.
-            #   A hash of the same form as `Google::Ads::GoogleAds::V0::Services::KeywordPlanCampaignOperation`
-            #   can also be provided.
-            # @param partial_failure [true, false]
-            #   If true, successful operations will be carried out and invalid
-            #   operations will return errors. If false, all operations will be carried
-            #   out in one transaction if and only if they are all valid.
-            #   Default is false.
-            # @param validate_only [true, false]
-            #   If true, the request is validated but not executed. Only errors are
-            #   returned, not results.
-            # @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::V0::Services::MutateKeywordPlanCampaignsResponse]
-            # @yieldparam operation [GRPC::ActiveCall::Operation]
-            # @return [Google::Ads::GoogleAds::V0::Services::MutateKeywordPlanCampaignsResponse]
-            # @raise [Google::Gax::GaxError] if the RPC is aborted.
-            # @example
-            #   require "google/ads/google_ads"
-            #
-            #   keyword_plan_campaign_service_client = Google::Ads::GoogleAds::KeywordPlanCampaign.new(version: :v0)
-            #
-            #   # TODO: Initialize `customer_id`:
-            #   customer_id = ''
-            #
-            #   # TODO: Initialize `operations`:
-            #   operations = []
-            #   response = keyword_plan_campaign_service_client.mutate_keyword_plan_campaigns(customer_id, operations)
-
-            def mutate_keyword_plan_campaigns \
-                customer_id,
-                operations,
-                partial_failure: nil,
-                validate_only: nil,
-                options: nil,
-                &block
-              req = {
-                customer_id: customer_id,
-                operations: operations,
-                partial_failure: partial_failure,
-                validate_only: validate_only
-              }.delete_if { |_, v| v.nil? }
-              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V0::Services::MutateKeywordPlanCampaignsRequest)
-              @mutate_keyword_plan_campaigns.call(req, options, &block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_client_config.json

@@ -1,36 +0,0 @@
-{
-  "interfaces": {
-    "google.ads.googleads.v0.services.KeywordPlanCampaignService": {
-      "retry_codes": {
-        "idempotent": [
-          "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
-        ],
-        "non_idempotent": []
-      },
-      "retry_params": {
-        "default": {
-          "initial_retry_delay_millis": 100,
-          "retry_delay_multiplier": 1.3,
-          "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 20000,
-          "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 20000,
-          "total_timeout_millis": 600000
-        }
-      },
-      "methods": {
-        "GetKeywordPlanCampaign": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "MutateKeywordPlanCampaigns": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        }
-      }
-    }
-  }
-}

data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_pb.rb

@@ -1,44 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: google/ads/google_ads/v0/services/keyword_plan_campaign_service.proto
-
-require 'google/protobuf'
-
-require 'google/ads/google_ads/v0/resources/keyword_plan_campaign_pb'
-require 'google/api/annotations_pb'
-require 'google/protobuf/field_mask_pb'
-require 'google/protobuf/wrappers_pb'
-require 'google/rpc/status_pb'
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "google.ads.googleads.v0.services.GetKeywordPlanCampaignRequest" do
-    optional :resource_name, :string, 1
-  end
-  add_message "google.ads.googleads.v0.services.MutateKeywordPlanCampaignsRequest" do
-    optional :customer_id, :string, 1
-    repeated :operations, :message, 2, "google.ads.googleads.v0.services.KeywordPlanCampaignOperation"
-    optional :partial_failure, :bool, 3
-    optional :validate_only, :bool, 4
-  end
-  add_message "google.ads.googleads.v0.services.KeywordPlanCampaignOperation" do
-    optional :update_mask, :message, 4, "google.protobuf.FieldMask"
-    oneof :operation do
-      optional :create, :message, 1, "google.ads.googleads.v0.resources.KeywordPlanCampaign"
-      optional :update, :message, 2, "google.ads.googleads.v0.resources.KeywordPlanCampaign"
-      optional :remove, :string, 3
-    end
-  end
-  add_message "google.ads.googleads.v0.services.MutateKeywordPlanCampaignsResponse" do
-    optional :partial_failure_error, :message, 3, "google.rpc.Status"
-    repeated :results, :message, 2, "google.ads.googleads.v0.services.MutateKeywordPlanCampaignResult"
-  end
-  add_message "google.ads.googleads.v0.services.MutateKeywordPlanCampaignResult" do
-    optional :resource_name, :string, 1
-  end
-end
-
-module Google::Ads::GoogleAds::V0::Services
-  GetKeywordPlanCampaignRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.GetKeywordPlanCampaignRequest").msgclass
-  MutateKeywordPlanCampaignsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateKeywordPlanCampaignsRequest").msgclass
-  KeywordPlanCampaignOperation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.KeywordPlanCampaignOperation").msgclass
-  MutateKeywordPlanCampaignsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateKeywordPlanCampaignsResponse").msgclass
-  MutateKeywordPlanCampaignResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v0.services.MutateKeywordPlanCampaignResult").msgclass
-end

data/lib/google/ads/google_ads/v0/services/keyword_plan_campaign_service_services_pb.rb

@@ -1,43 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: google/ads/google_ads/v0/services/keyword_plan_campaign_service.proto for package 'Google::Ads::GoogleAds::V0::Services'
-# Original file comments:
-# Copyright 2018 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/v0/services/keyword_plan_campaign_service_pb'
-
-module Google::Ads::GoogleAds::V0::Services
-  module KeywordPlanCampaignService
-    # Service to manage Keyword Plan campaigns.
-    class Service
-
-      include GRPC::GenericService
-
-      self.marshal_class_method = :encode
-      self.unmarshal_class_method = :decode
-      self.service_name = 'google.ads.googleads.v0.services.KeywordPlanCampaignService'
-
-      # Returns the requested Keyword Plan campaign in full detail.
-      rpc :GetKeywordPlanCampaign, GetKeywordPlanCampaignRequest, Google::Ads::GoogleAds::V0::Resources::KeywordPlanCampaign
-      # Creates, updates, or removes Keyword Plan campaigns. Operation statuses are
-      # returned.
-      rpc :MutateKeywordPlanCampaigns, MutateKeywordPlanCampaignsRequest, MutateKeywordPlanCampaignsResponse
-    end
-
-    Stub = Service.rpc_stub_class
-  end
-end