class Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client

Client for the BillingSetupService service.

A service for designating the business entity responsible for accrued costs.

A billing setup is associated with a payments account. Billing-related activity for all billing setups associated with a particular payments account will appear on a single invoice generated monthly.

Mutates: The REMOVE operation cancels a pending billing setup. The CREATE operation creates a new billing setup.

Attributes

billing_setup_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the BillingSetupService Client class.

See {::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client::Configuration} for a description of the configuration fields.

## Example

To modify the configuration for all BillingSetupService clients:

::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/billing_setup_service/client.rb, line 66
def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 3600.0
    default_config.retry_policy = {
      initial_delay: 5.0,
    max_delay: 60.0,
    multiplier: 1.3,
    retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new BillingSetupService client object.

## Examples

To create a new BillingSetupService client with the default configuration:

client = ::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client.new

To create a new BillingSetupService client with a custom configuration:

client = ::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the BillingSetupService client. @yieldparam config [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/billing_setup_service/client.rb, line 124
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/ads/google_ads/v7/services/billing_setup_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @billing_setup_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the BillingSetupService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Ads::GoogleAds::V7::Services::BillingSetupService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/ads/google_ads/v7/services/billing_setup_service/client.rb, line 99
def configure
  yield @config if block_given?
  @config
end
get_billing_setup(request, options = nil) { |response, operation| ... } click to toggle source

Returns a billing setup.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[HeaderError]()
[InternalError]()
[QuotaError]()
[RequestError]()

@overload get_billing_setup(request, options = nil)

Pass arguments to `get_billing_setup` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::GetBillingSetupRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::Services::GetBillingSetupRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_billing_setup(resource_name: nil)

Pass arguments to `get_billing_setup` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param resource_name [::String]
  Required. The resource name of the billing setup to fetch.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Resources::BillingSetup] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V7::Resources::BillingSetup]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/billing_setup_service/client.rb, line 200
def get_billing_setup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::Services::GetBillingSetupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_billing_setup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "resource_name" => request.resource_name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_billing_setup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_billing_setup.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @billing_setup_service_stub.call_rpc :get_billing_setup, request,
                                       options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end
mutate_billing_setup(request, options = nil) { |response, operation| ... } click to toggle source

Creates a billing setup, or cancels an existing billing setup.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[BillingSetupError]()
[DateError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[QuotaError]()
[RequestError]()

@overload mutate_billing_setup(request, options = nil)

Pass arguments to `mutate_billing_setup` via a request object, either of type
{::Google::Ads::GoogleAds::V7::Services::MutateBillingSetupRequest} or an equivalent Hash.

@param request [::Google::Ads::GoogleAds::V7::Services::MutateBillingSetupRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload mutate_billing_setup(customer_id: nil, operation: nil)

Pass arguments to `mutate_billing_setup` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param customer_id [::String]
  Required. Id of the customer to apply the billing setup mutate operation to.
@param operation [::Google::Ads::GoogleAds::V7::Services::BillingSetupOperation, ::Hash]
  Required. The operation to perform.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V7::Services::MutateBillingSetupResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V7::Services::MutateBillingSetupResponse]

@raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.

# File lib/google/ads/google_ads/v7/services/billing_setup_service/client.rb, line 282
def mutate_billing_setup request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V7::Services::MutateBillingSetupRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.mutate_billing_setup.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Ads::GoogleAds::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "customer_id" => request.customer_id
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.mutate_billing_setup.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_billing_setup.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @billing_setup_service_stub.call_rpc :mutate_billing_setup, request,
                                       options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
  # rescue GRPC::BadStatus => grpc_error
  #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
end