Class: Google::Ads::GoogleAds::V5::Services::CustomerLabelService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/ads/google_ads/v5/services/customer_label_service/client.rb

Overview

Client for the CustomerLabelService service.

Service to manage labels on customers.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#customer_label_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CustomerLabelService client object.

## Examples

To create a new CustomerLabelService client with the default configuration:

client = ::Google::Ads::GoogleAds::V5::Services::CustomerLabelService::Client.new

To create a new CustomerLabelService client with a custom configuration:

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

Yields:

  • (config) —

    Configure the CustomerLabelService client.

Yield Parameters:



116
117
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
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 116

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/customer_label_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

  @customer_label_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V5::Services::CustomerLabelService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#customer_label_service_stub ⇒ Object (readonly) 



37
38
39
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 37

def customer_label_service_stub
  @customer_label_service_stub
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CustomerLabelService Client class.

See Configuration for a description of the configuration fields.

## Example

To modify the configuration for all CustomerLabelService clients:

::Google::Ads::GoogleAds::V5::Services::CustomerLabelService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 58

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 CustomerLabelService 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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



91
92
93
94
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 91

def configure
  yield @config if block_given?
  @config
end

#get_customer_label(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CustomerLabel #get_customer_label(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CustomerLabel

Returns the requested customer-label relationship in full detail.

Overloads:

  • #get_customer_label(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CustomerLabel

    Pass arguments to ‘get_customer_label` via a request object, either of type GetCustomerLabelRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V5::Services::GetCustomerLabelRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_customer_label(resource_name: nil) ⇒ ::Google::Ads::GoogleAds::V5::Resources::CustomerLabel

    Pass arguments to ‘get_customer_label` 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).

    Parameters:

    • resource_name (::String) (defaults to: nil) —

      Required. The resource name of the customer-label relationship to fetch.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



178
179
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
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 178

def get_customer_label request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::GetCustomerLabelRequest

  # 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_customer_label.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_customer_label.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_customer_label.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @customer_label_service_stub.call_rpc :get_customer_label, 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_customer_labels(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsResponse #mutate_customer_labels(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsResponse

Creates and removes customer-label relationships. Operation statuses are returned.

Overloads:

  • #mutate_customer_labels(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsResponse

    Pass arguments to ‘mutate_customer_labels` via a request object, either of type MutateCustomerLabelsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsRequest, ::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #mutate_customer_labels(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsResponse

    Pass arguments to ‘mutate_customer_labels` 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).

    Parameters:

    • customer_id (::String) (defaults to: nil) —

      Required. ID of the customer whose customer-label relationships are being modified.

    • operations (::Array<::Google::Ads::GoogleAds::V5::Services::CustomerLabelOperation, ::Hash>) (defaults to: nil) —

      Required. The list of operations to perform on customer-label relationships.

    • partial_failure (::Boolean) (defaults to: nil) —

      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.

    • validate_only (::Boolean) (defaults to: nil) —

      If true, the request is validated but not executed. Only errors are returned, not results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Ads::GoogleAds::Error) —

    if the RPC is aborted.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/ads/google_ads/v5/services/customer_label_service/client.rb', line 255

def mutate_customer_labels request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V5::Services::MutateCustomerLabelsRequest

  # 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_customer_labels.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_customer_labels.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_customer_labels.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @customer_label_service_stub.call_rpc :mutate_customer_labels, 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