Class: Google::Ads::GoogleAds::V15::Services::UserListService::Client

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

Overview

Client for the UserListService service.

Service to manage user lists.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#user_list_path

Constructor Details

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

Create a new UserListService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Ads::GoogleAds::V15::Services::UserListService::Client.new

# Create a client using a custom configuration
client = ::Google::Ads::GoogleAds::V15::Services::UserListService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the UserListService client.

Yield Parameters:



108
109
110
111
112
113
114
115
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
 
# File 'lib/google/ads/google_ads/v15/services/user_list_service/client.rb', line 108

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/v15/services/user_list_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 endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_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

  @user_list_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V15::Services::UserListService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#user_list_service_stub ⇒ Object (readonly) 



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

def user_list_service_stub
  @user_list_service_stub
end

Class Method Details

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

Configure the UserListService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all UserListService clients
::Google::Ads::GoogleAds::V15::Services::UserListService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/ads/google_ads/v15/services/user_list_service/client.rb', line 57

def self.configure
  @configure ||= begin
    default_config = Client::Configuration.new

    default_config.timeout = 14_400.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 UserListService 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:



87
88
89
90
 
# File 'lib/google/ads/google_ads/v15/services/user_list_service/client.rb', line 87

def configure
  yield @config if block_given?
  @config
end

#mutate_user_lists(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateUserListsResponse #mutate_user_lists(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateUserListsResponse

Creates or updates user lists. Operation statuses are returned.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[CollectionSizeError]()
[DatabaseError]()
[DistinctError]()
[FieldError]()
[FieldMaskError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[NewResourceCreationError]()
[NotAllowlistedError]()
[NotEmptyError]()
[OperationAccessDeniedError]()
[QuotaError]()
[RangeError]()
[RequestError]()
[StringFormatError]()
[StringLengthError]()
[UserListError]()

Examples:

Basic example

require "google/ads/google_ads/v15/services"

# Create a client object. The client can be reused for multiple calls.
client = Google::Ads::GoogleAds::V15::Services::UserListService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Ads::GoogleAds::V15::Services::MutateUserListsRequest.new

# Call the mutate_user_lists method.
result = client.mutate_user_lists request

# The returned object is of type Google::Ads::GoogleAds::V15::Services::MutateUserListsResponse.
p result

Overloads:

  • #mutate_user_lists(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateUserListsResponse

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

    Parameters:

    • request (::Google::Ads::GoogleAds::V15::Services::MutateUserListsRequest, ::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_user_lists(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil) ⇒ ::Google::Ads::GoogleAds::V15::Services::MutateUserListsResponse

    Pass arguments to ‘mutate_user_lists` 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. The ID of the customer whose user lists are being modified.

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

      Required. The list of operations to perform on individual user lists.

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/google/ads/google_ads/v15/services/user_list_service/client.rb', line 223

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

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V15::Services::MutateUserListsRequest

  # 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_user_lists.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 = {}
  if request.customer_id
    header_params["customer_id"] = request.customer_id
  end

  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_user_lists.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_user_lists.retry_policy

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

  @user_list_service_stub.call_rpc :mutate_user_lists, 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