google-ads-googleads 2.4.1 → 3.0.0

data/lib/google/ads/google_ads/v2/services/recommendation_service_client_config.json

@@ -0,0 +1,41 @@
+{
+  "interfaces": {
+    "google.ads.googleads.v2.services.RecommendationService": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 5000,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 3600000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 3600000,
+          "total_timeout_millis": 3600000
+        }
+      },
+      "methods": {
+        "GetRecommendation": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "ApplyRecommendation": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DismissRecommendation": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/ads/google_ads/v2/services/recommendation_service_pb.rb

@@ -0,0 +1,105 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/ads/google_ads/v2/services/recommendation_service.proto
+
+require 'google/protobuf'
+
+require 'google/ads/google_ads/v2/common/extensions_pb'
+require 'google/ads/google_ads/v2/enums/keyword_match_type_pb'
+require 'google/ads/google_ads/v2/resources/ad_pb'
+require 'google/ads/google_ads/v2/resources/recommendation_pb'
+require 'google/api/annotations_pb'
+require 'google/protobuf/wrappers_pb'
+require 'google/rpc/status_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.ads.googleads.v2.services.GetRecommendationRequest" do
+    optional :resource_name, :string, 1
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationRequest" do
+    optional :customer_id, :string, 1
+    repeated :operations, :message, 2, "google.ads.googleads.v2.services.ApplyRecommendationOperation"
+    optional :partial_failure, :bool, 3
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation" do
+    optional :resource_name, :string, 1
+    oneof :apply_parameters do
+      optional :campaign_budget, :message, 2, "google.ads.googleads.v2.services.ApplyRecommendationOperation.CampaignBudgetParameters"
+      optional :text_ad, :message, 3, "google.ads.googleads.v2.services.ApplyRecommendationOperation.TextAdParameters"
+      optional :keyword, :message, 4, "google.ads.googleads.v2.services.ApplyRecommendationOperation.KeywordParameters"
+      optional :target_cpa_opt_in, :message, 5, "google.ads.googleads.v2.services.ApplyRecommendationOperation.TargetCpaOptInParameters"
+      optional :callout_extension, :message, 6, "google.ads.googleads.v2.services.ApplyRecommendationOperation.CalloutExtensionParameters"
+      optional :call_extension, :message, 7, "google.ads.googleads.v2.services.ApplyRecommendationOperation.CallExtensionParameters"
+      optional :sitelink_extension, :message, 8, "google.ads.googleads.v2.services.ApplyRecommendationOperation.SitelinkExtensionParameters"
+      optional :move_unused_budget, :message, 9, "google.ads.googleads.v2.services.ApplyRecommendationOperation.MoveUnusedBudgetParameters"
+    end
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.CampaignBudgetParameters" do
+    optional :new_budget_amount_micros, :message, 1, "google.protobuf.Int64Value"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.TextAdParameters" do
+    optional :ad, :message, 1, "google.ads.googleads.v2.resources.Ad"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.KeywordParameters" do
+    optional :ad_group, :message, 1, "google.protobuf.StringValue"
+    optional :match_type, :enum, 2, "google.ads.googleads.v2.enums.KeywordMatchTypeEnum.KeywordMatchType"
+    optional :cpc_bid_micros, :message, 3, "google.protobuf.Int64Value"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.TargetCpaOptInParameters" do
+    optional :target_cpa_micros, :message, 1, "google.protobuf.Int64Value"
+    optional :new_campaign_budget_amount_micros, :message, 2, "google.protobuf.Int64Value"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.CalloutExtensionParameters" do
+    repeated :callout_extensions, :message, 1, "google.ads.googleads.v2.common.CalloutFeedItem"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.CallExtensionParameters" do
+    repeated :call_extensions, :message, 1, "google.ads.googleads.v2.common.CallFeedItem"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.SitelinkExtensionParameters" do
+    repeated :sitelink_extensions, :message, 1, "google.ads.googleads.v2.common.SitelinkFeedItem"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationOperation.MoveUnusedBudgetParameters" do
+    optional :budget_micros_to_move, :message, 1, "google.protobuf.Int64Value"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationResponse" do
+    repeated :results, :message, 1, "google.ads.googleads.v2.services.ApplyRecommendationResult"
+    optional :partial_failure_error, :message, 2, "google.rpc.Status"
+  end
+  add_message "google.ads.googleads.v2.services.ApplyRecommendationResult" do
+    optional :resource_name, :string, 1
+  end
+  add_message "google.ads.googleads.v2.services.DismissRecommendationRequest" do
+    optional :customer_id, :string, 1
+    repeated :operations, :message, 3, "google.ads.googleads.v2.services.DismissRecommendationRequest.DismissRecommendationOperation"
+    optional :partial_failure, :bool, 2
+  end
+  add_message "google.ads.googleads.v2.services.DismissRecommendationRequest.DismissRecommendationOperation" do
+    optional :resource_name, :string, 1
+  end
+  add_message "google.ads.googleads.v2.services.DismissRecommendationResponse" do
+    repeated :results, :message, 1, "google.ads.googleads.v2.services.DismissRecommendationResponse.DismissRecommendationResult"
+    optional :partial_failure_error, :message, 2, "google.rpc.Status"
+  end
+  add_message "google.ads.googleads.v2.services.DismissRecommendationResponse.DismissRecommendationResult" do
+    optional :resource_name, :string, 1
+  end
+end
+
+module Google::Ads::GoogleAds::V2::Services
+  GetRecommendationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.GetRecommendationRequest").msgclass
+  ApplyRecommendationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationRequest").msgclass
+  ApplyRecommendationOperation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation").msgclass
+  ApplyRecommendationOperation::CampaignBudgetParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.CampaignBudgetParameters").msgclass
+  ApplyRecommendationOperation::TextAdParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.TextAdParameters").msgclass
+  ApplyRecommendationOperation::KeywordParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.KeywordParameters").msgclass
+  ApplyRecommendationOperation::TargetCpaOptInParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.TargetCpaOptInParameters").msgclass
+  ApplyRecommendationOperation::CalloutExtensionParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.CalloutExtensionParameters").msgclass
+  ApplyRecommendationOperation::CallExtensionParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.CallExtensionParameters").msgclass
+  ApplyRecommendationOperation::SitelinkExtensionParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.SitelinkExtensionParameters").msgclass
+  ApplyRecommendationOperation::MoveUnusedBudgetParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationOperation.MoveUnusedBudgetParameters").msgclass
+  ApplyRecommendationResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationResponse").msgclass
+  ApplyRecommendationResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.ApplyRecommendationResult").msgclass
+  DismissRecommendationRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.DismissRecommendationRequest").msgclass
+  DismissRecommendationRequest::DismissRecommendationOperation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.DismissRecommendationRequest.DismissRecommendationOperation").msgclass
+  DismissRecommendationResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.DismissRecommendationResponse").msgclass
+  DismissRecommendationResponse::DismissRecommendationResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.ads.googleads.v2.services.DismissRecommendationResponse.DismissRecommendationResult").msgclass
+end

data/lib/google/ads/google_ads/v2/services/recommendation_service_services_pb.rb

@@ -0,0 +1,46 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/ads/google_ads/v2/services/recommendation_service.proto for package 'Google::Ads::GoogleAds::V2::Services'
+# Original file comments:
+# 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
+#
+#     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/v2/services/recommendation_service_pb'
+
+module Google::Ads::GoogleAds::V2::Services
+  module RecommendationService
+    # Proto file describing the Recommendation service.
+    #
+    # Service to manage recommendations.
+    class Service
+
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'google.ads.googleads.v2.services.RecommendationService'
+
+      # Returns the requested recommendation in full detail.
+      rpc :GetRecommendation, GetRecommendationRequest, Google::Ads::GoogleAds::V2::Resources::Recommendation
+      # Applies given recommendations with corresponding apply parameters.
+      rpc :ApplyRecommendation, ApplyRecommendationRequest, ApplyRecommendationResponse
+      # Dismisses given recommendations.
+      rpc :DismissRecommendation, DismissRecommendationRequest, DismissRecommendationResponse
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/google/ads/google_ads/v2/services/remarketing_action_service_client.rb

@@ -0,0 +1,285 @@
+# 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/v2/services/remarketing_action_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/v2/services/remarketing_action_service_pb"
+require "google/ads/google_ads/v2/services/credentials"
+
+module Google
+  module Ads
+    module GoogleAds
+      module V2
+        module Services
+          # Service to manage remarketing actions.
+          #
+          # @!attribute [r] remarketing_action_service_stub
+          #   @return [Google::Ads::GoogleAds::V2::Services::RemarketingActionService::Stub]
+          class RemarketingActionServiceClient
+            attr_reader :remarketing_action_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
+
+
+            REMARKETING_ACTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "customers/{customer}/remarketingActions/{remarketing_action}"
+            )
+
+            private_constant :REMARKETING_ACTION_PATH_TEMPLATE
+
+            # Returns a fully-qualified remarketing_action resource name string.
+            # @param customer [String]
+            # @param remarketing_action [String]
+            # @return [String]
+            def self.remarketing_action_path customer, remarketing_action
+              REMARKETING_ACTION_PATH_TEMPLATE.render(
+                :"customer" => customer,
+                :"remarketing_action" => remarketing_action
+              )
+            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/v2/services/remarketing_action_service_services_pb"
+
+              credentials ||= Google::Ads::GoogleAds::V2::Services::Credentials.default
+
+              if credentials.is_a?(String) || credentials.is_a?(Hash)
+                updater_proc = Google::Ads::GoogleAds::V2::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(
+                "remarketing_action_service_client_config.json"
+              )
+              defaults = client_config_file.open do |f|
+                Google::Gax.construct_settings(
+                  "google.ads.googleads.v2.services.RemarketingActionService",
+                  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
+              @remarketing_action_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::V2::Services::RemarketingActionService::Stub.method(:new)
+              )
+
+              @get_remarketing_action = Google::Gax.create_api_call(
+                @remarketing_action_service_stub.method(:get_remarketing_action),
+                defaults["get_remarketing_action"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'resource_name' => request.resource_name}
+                end
+              )
+              @mutate_remarketing_actions = Google::Gax.create_api_call(
+                @remarketing_action_service_stub.method(:mutate_remarketing_actions),
+                defaults["mutate_remarketing_actions"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'customer_id' => request.customer_id}
+                end
+              )
+            end
+
+            # Service calls
+
+            # Returns the requested remarketing action in full detail.
+            #
+            # @param resource_name [String]
+            #   The resource name of the remarketing action 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::V2::Resources::RemarketingAction]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::GoogleAds::V2::Resources::RemarketingAction]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   remarketing_action_client = Google::Ads::GoogleAds::RemarketingAction.new(version: :v2)
+            #   formatted_resource_name = Google::Ads::GoogleAds::V2::Services::RemarketingActionServiceClient.remarketing_action_path("[CUSTOMER]", "[REMARKETING_ACTION]")
+            #   response = remarketing_action_client.get_remarketing_action(formatted_resource_name)
+
+            def get_remarketing_action \
+                resource_name,
+                options: nil,
+                &block
+              req = {
+                resource_name: resource_name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Ads::GoogleAds::V2::Services::GetRemarketingActionRequest)
+              @get_remarketing_action.call(req, options, &block)
+            end
+
+            # Creates or updates remarketing actions. Operation statuses are returned.
+            #
+            # @param customer_id [String]
+            #   The ID of the customer whose remarketing actions are being modified.
+            # @param operations [Array<Google::Ads::GoogleAds::V2::Services::RemarketingActionOperation | Hash>]
+            #   The list of operations to perform on individual remarketing actions.
+            #   A hash of the same form as `Google::Ads::GoogleAds::V2::Services::RemarketingActionOperation`
+            #   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::V2::Services::MutateRemarketingActionsResponse]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Ads::GoogleAds::V2::Services::MutateRemarketingActionsResponse]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/ads/google_ads"
+            #
+            #   remarketing_action_client = Google::Ads::GoogleAds::RemarketingAction.new(version: :v2)
+            #
+            #   # TODO: Initialize `customer_id`:
+            #   customer_id = ''
+            #
+            #   # TODO: Initialize `operations`:
+            #   operations = []
+            #   response = remarketing_action_client.mutate_remarketing_actions(customer_id, operations)
+
+            def mutate_remarketing_actions \
+                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::V2::Services::MutateRemarketingActionsRequest)
+              @mutate_remarketing_actions.call(req, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end