Class: Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Client
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Client
- Includes:
- Paths
- Defined in:
- lib/google/ads/google_ads/v5/services/account_budget_service/client.rb
Overview
Client for the AccountBudgetService service.
A service for fetching an account-level budget.
Account-level budgets are mutated by creating proposal resources.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AccountBudgetService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AccountBudgetService Client instance.
-
#get_account_budget(request, options = nil) {|response, operation| ... } ⇒ ::Google::Ads::GoogleAds::V5::Resources::AccountBudget
Returns an account-level budget in full detail.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AccountBudgetService client object.
Methods included from Paths
#account_budget_path, #account_budget_proposal_path, #billing_setup_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AccountBudgetService client object.
## Examples
To create a new AccountBudgetService client with the default configuration:
client = ::Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Client.new
To create a new AccountBudgetService client with a custom configuration:
client = ::Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Client.new do |config|
config.timeout = 10.0
end
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/google/ads/google_ads/v5/services/account_budget_service/client.rb', line 118 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/v5/services/account_budget_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @account_budget_service_stub = ::Gapic::ServiceStub.new( ::Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#account_budget_service_stub ⇒ Object (readonly)
39 40 41 |
# File 'lib/google/ads/google_ads/v5/services/account_budget_service/client.rb', line 39 def account_budget_service_stub @account_budget_service_stub end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AccountBudgetService Client class.
See Configuration for a description of the configuration fields.
## Example
To modify the configuration for all AccountBudgetService clients:
::Google::Ads::GoogleAds::V5::Services::AccountBudgetService::Client.configure do |config|
config.timeout = 10.0
end
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/ads/google_ads/v5/services/account_budget_service/client.rb', line 60 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 |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the AccountBudgetService 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 configure.
See Configuration for a description of the configuration fields.
93 94 95 96 |
# File 'lib/google/ads/google_ads/v5/services/account_budget_service/client.rb', line 93 def configure yield @config if block_given? @config end |
#get_account_budget(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::AccountBudget #get_account_budget(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::AccountBudget
Returns an account-level budget in full detail.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/google/ads/google_ads/v5/services/account_budget_service/client.rb', line 180 def get_account_budget request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::GetAccountBudgetRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_account_budget..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_account_budget.timeout, metadata: , retry_policy: @config.rpcs.get_account_budget.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @account_budget_service_stub.call_rpc :get_account_budget, request, 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 |