Class: Google::Ads::GoogleAds::V16::Services::KeywordPlanIdeaService::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb

Overview

Configuration class for the KeywordPlanIdeaService API.

This class represents the configuration for KeywordPlanIdeaService, 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 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:


# Modify the global config, setting the timeout for
# generate_keyword_ideas to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Ads::GoogleAds::V16::Services::KeywordPlanIdeaService::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.generate_keyword_ideas.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Ads::GoogleAds::V16::Services::KeywordPlanIdeaService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.generate_keyword_ideas.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT =

The endpoint specific to the default “googleapis.com” universe. Deprecated.

"googleads.googleapis.com"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent_config = nil) {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



747
748
749
750
751
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 747

def initialize parent_config = nil
  @parent_config = parent_config unless parent_config.nil?

  yield self if block_given?
end

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a ‘GRPC::Core::Channel` object is provided as the credential.

Returns:

  • (::Hash) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#credentials ⇒ ::Object

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://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
*  (`Signet::OAuth2::Client`) A signet oauth2 client object
   (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
*  (`GRPC::Core::Channel`) a gRPC channel with included credentials
*  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
*  (`nil`) indicating no credentials

Returns:

  • (::Object) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional gRPC headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#retry_policy ⇒ ::Hash

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.

Returns:

  • (::Hash) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default “googleapis.com” universe).

Returns:

  • (::String, nil) 


721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 721

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "googleads.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the KeywordPlanIdeaService 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 seconds
  #  *  `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 `generate_keyword_ideas`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_ideas
    ##
    # RPC-specific configuration for `generate_keyword_historical_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_historical_metrics
    ##
    # RPC-specific configuration for `generate_ad_group_themes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_ad_group_themes
    ##
    # RPC-specific configuration for `generate_keyword_forecast_metrics`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :generate_keyword_forecast_metrics

    # @private
    def initialize parent_rpcs = nil
      generate_keyword_ideas_config = parent_rpcs.generate_keyword_ideas if parent_rpcs.respond_to? :generate_keyword_ideas
      @generate_keyword_ideas = ::Gapic::Config::Method.new generate_keyword_ideas_config
      generate_keyword_historical_metrics_config = parent_rpcs.generate_keyword_historical_metrics if parent_rpcs.respond_to? :generate_keyword_historical_metrics
      @generate_keyword_historical_metrics = ::Gapic::Config::Method.new generate_keyword_historical_metrics_config
      generate_ad_group_themes_config = parent_rpcs.generate_ad_group_themes if parent_rpcs.respond_to? :generate_ad_group_themes
      @generate_ad_group_themes = ::Gapic::Config::Method.new generate_ad_group_themes_config
      generate_keyword_forecast_metrics_config = parent_rpcs.generate_keyword_forecast_metrics if parent_rpcs.respond_to? :generate_keyword_forecast_metrics
      @generate_keyword_forecast_metrics = ::Gapic::Config::Method.new generate_keyword_forecast_metrics_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


769
770
771
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 769

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



757
758
759
760
761
762
763
 
# File 'lib/google/ads/google_ads/v16/services/keyword_plan_idea_service/client.rb', line 757

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