Class: Google::Ads::GoogleAds::V24::Services::ContentCreatorInsightsService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb

Overview

Client for the ContentCreatorInsightsService service.

Content Creator Insights Service helps users find information about YouTube Creators and their content and how these creators and their audiences can be reached with Google Ads. Refer to the [YouTube creator insights guide](developers.google.com/google-ads/api/docs/insights/creator-insights) for more details. Accessible to allowlisted customers only.

Defined Under Namespace

Classes: Configuration

Constant Summary collapse

API_VERSION = 
""
DEFAULT_ENDPOINT_TEMPLATE = 
"googleads.$UNIVERSE_DOMAIN$"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new ContentCreatorInsightsService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ContentCreatorInsightsService client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 126

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/v24/services/content_creator_insights_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.nil? ||
                           (@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

  @content_creator_insights_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V24::Services::ContentCreatorInsightsService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @content_creator_insights_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#content_creator_insights_service_stub ⇒ Object (readonly) 



46
47
48
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 46

def content_creator_insights_service_stub
  @content_creator_insights_service_stub
end

Class Method Details

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

Configure the ContentCreatorInsightsService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 66

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 ContentCreatorInsightsService 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:



96
97
98
99
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#generate_creator_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsResponse #generate_creator_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, country_locations: nil, sub_country_locations: nil, supplemental_data: nil, search_attributes: nil, search_brand: nil, search_channels: nil, search_topics: nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsResponse

Returns insights for a collection of YouTube Creators and Channels.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v24/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsResponse.
p result

Overloads:

  • #generate_creator_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsResponse

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

    Parameters:

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

  • #generate_creator_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, country_locations: nil, sub_country_locations: nil, supplemental_data: nil, search_attributes: nil, search_brand: nil, search_channels: nil, search_topics: nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsResponse

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

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

      Required. The name of the customer being planned for. This is a user-defined value.

    • insights_application_info (::Google::Ads::GoogleAds::V24::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

    • country_locations (::Array<::Google::Ads::GoogleAds::V24::Common::LocationInfo, ::Hash>) (defaults to: nil) —

      Required. The countries to search that apply to the criteria.

    • sub_country_locations (::Array<::Google::Ads::GoogleAds::V24::Common::LocationInfo, ::Hash>) (defaults to: nil) —

      The sub-country geographic locations to search that apply to the criteria. Only supported for SearchAttributes criteria.

    • supplemental_data (::Array<::Google::Ads::GoogleAds::V24::Enums::ContentCreatorInsightsSupplementalDataEnum::ContentCreatorInsightsSupplementalData>) (defaults to: nil) —

      Optional. Optional features to include in the response. By default, only core insight data is returned. Including supplemental data here will populate additional fields in the response.

    • search_attributes (::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsRequest::SearchAttributes, ::Hash) (defaults to: nil) —

      The attributes used to identify top creators. Data fetched is based on the list of countries or sub-country locations specified in country_locations or sub_country_locations.

      Note: The following parameters are mutually exclusive: ‘search_attributes`, `search_brand`, `search_channels`, `search_topics`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • search_brand (::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsRequest::SearchBrand, ::Hash) (defaults to: nil) —

      A brand used to search for top creators. Data fetched is based on the list of countries specified in country_locations.This option is deprecated and will be removed in the V25 release. Use search_topics instead.

      Note: The following parameters are mutually exclusive: ‘search_brand`, `search_attributes`, `search_channels`, `search_topics`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • search_channels (::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsRequest::YouTubeChannels, ::Hash) (defaults to: nil) —

      YouTube Channel IDs for Creator Insights. Data fetched for channels is based on the list of countries specified in country_locations.

      Note: The following parameters are mutually exclusive: ‘search_channels`, `search_attributes`, `search_brand`, `search_topics`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • search_topics (::Google::Ads::GoogleAds::V24::Services::SearchTopics, ::Hash) (defaults to: nil) —

      Search for relevant creators who make content about the specified topics. Data fetched is based on the country specified in country_locations. Note: This option allows searching for one country only.

      Note: The following parameters are mutually exclusive: ‘search_topics`, `search_attributes`, `search_brand`, `search_channels`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 287

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V24::Services::GenerateCreatorInsightsRequest

  # 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.generate_creator_insights.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_creator_insights.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_creator_insights.retry_policy

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

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

#generate_trending_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsResponse #generate_trending_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, country_location: nil, sub_country_locations: nil, supplemental_data: nil, search_audience: nil, search_topics: nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsResponse

Returns insights for trending content on YouTube.

List of thrown errors:

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

Examples:

Basic example

require "google/ads/google_ads/v24/services"

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

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

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

# The returned object is of type Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsResponse.
p result

Overloads:

  • #generate_trending_insights(request, options = nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsResponse

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

    Parameters:

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

  • #generate_trending_insights(customer_id: nil, customer_insights_group: nil, insights_application_info: nil, country_location: nil, sub_country_locations: nil, supplemental_data: nil, search_audience: nil, search_topics: nil) ⇒ ::Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsResponse

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

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

      Required. The name of the customer being planned for. This is a user-defined value.

    • insights_application_info (::Google::Ads::GoogleAds::V24::Common::AdditionalApplicationInfo, ::Hash) (defaults to: nil) —

      Optional. Additional information on the application issuing the request.

    • country_location (::Google::Ads::GoogleAds::V24::Common::LocationInfo, ::Hash) (defaults to: nil) —

      Required. The country to find trends in.

    • sub_country_locations (::Array<::Google::Ads::GoogleAds::V24::Common::LocationInfo, ::Hash>) (defaults to: nil) —

      Optional. The sub-country geographic locations to search that apply to the criteria. Only supported for ‘search_audience` criteria.

    • supplemental_data (::Array<::Google::Ads::GoogleAds::V24::Enums::ContentCreatorInsightsSupplementalDataEnum::ContentCreatorInsightsSupplementalData>) (defaults to: nil) —

      Optional. Optional features to include in the response. By default, only core insight data is returned. Including supplemental data here will populate additional fields in the response.

    • search_audience (::Google::Ads::GoogleAds::V24::Services::SearchAudience, ::Hash) (defaults to: nil) —

      An audience to search for trending content in. Data fetched is based on the country or sub-country locations specified in country_location or sub_country_locations.

      Note: The following parameters are mutually exclusive: ‘search_audience`, `search_topics`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • search_topics (::Google::Ads::GoogleAds::V24::Services::SearchTopics, ::Hash) (defaults to: nil) —

      Content topics to return trend information for.

      Note: The following parameters are mutually exclusive: ‘search_topics`, `search_audience`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 409

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V24::Services::GenerateTrendingInsightsRequest

  # 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.generate_trending_insights.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.generate_trending_insights.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.generate_trending_insights.retry_policy

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

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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


182
183
184
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 182

def logger
  @content_creator_insights_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/ads/google_ads/v24/services/content_creator_insights_service/client.rb', line 106

def universe_domain
  @content_creator_insights_service_stub.universe_domain
end