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

Client for the GoogleAdsService service.

Service to fetch data and metrics across resources.

Attributes

google_ads_service_stub[R]

@private

Public Class Methods

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

Configure the GoogleAdsService Client class.

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

## Example

To modify the configuration for all GoogleAdsService clients:

::Google::Ads::GoogleAds::V7::Services::GoogleAdsService::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/google_ads_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
new() { |config| ... } click to toggle source

Create a new GoogleAdsService client object.

## Examples

To create a new GoogleAdsService client with the default configuration:

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

To create a new GoogleAdsService client with a custom configuration:

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

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

# File lib/google/ads/google_ads/v7/services/google_ads_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/v7/services/google_ads_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

  @google_ads_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V7::Services::GoogleAdsService::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 GoogleAdsService 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::GoogleAdsService::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/google_ads_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
mutate(request, options = nil) { |response, operation| ... } click to toggle source

Creates, updates, or removes resources. This method supports atomic transactions with multiple types of resources. For example, you can atomically create a campaign and a campaign budget, or perform up to thousands of mutates atomically.

This method is essentially a wrapper around a series of mutate methods. The only features it offers over calling those methods directly are:

  • Atomic transactions

  • Temp resource names (described below)

  • Somewhat reduced latency over making a series of mutate calls

Note: Only resources that support atomic transactions are included, so this method can't replace all calls to individual services.

## Atomic Transaction Benefits

Atomicity makes error handling much easier. If you're making a series of changes and one fails, it can leave your account in an inconsistent state. With atomicity, you either reach the desired state directly, or the request fails and you can retry.

## Temp Resource Names

Temp resource names are a special type of resource name used to create a resource and reference that resource in the same request. For example, if a campaign budget is created with `resource_name` equal to `customers/123/campaignBudgets/-1`, that resource name can be reused in the `Campaign.budget` field in the same request. That way, the two resources are created and linked atomically.

To create a temp resource name, put a negative number in the part of the name that the server would normally allocate.

Note:

  • Resources must be created with a temp name before the name can be reused. For example, the previous CampaignBudget+Campaign example would fail if the mutate order was reversed.

  • Temp names are not remembered across requests.

  • There's no limit to the number of temp names in a request.

  • Each temp name must use a unique negative number, even if the resource types differ.

## Latency

It's important to group mutates by resource type or the request may time out and fail. Latency is roughly equal to a series of calls to individual mutate methods, where each change in resource type is a new call. For example, mutating 10 campaigns then 10 ad groups is like 2 calls, while mutating 1 campaign, 1 ad group, 1 campaign, 1 ad group is like 4 calls.

List of thrown errors:

[AdCustomizerError]()
[AdError]()
[AdGroupAdError]()
[AdGroupCriterionError]()
[AdGroupError]()
[AssetError]()
[AuthenticationError]()
[AuthorizationError]()
[BiddingError]()
[CampaignBudgetError]()
[CampaignCriterionError]()
[CampaignError]()
[CampaignExperimentError]()
[CampaignSharedSetError]()
[CollectionSizeError]()
[ContextError]()
[ConversionActionError]()
[CriterionError]()
[CustomerFeedError]()
[DatabaseError]()
[DateError]()
[DateRangeError]()
[DistinctError]()
[ExtensionFeedItemError]()
[ExtensionSettingError]()
[FeedAttributeReferenceError]()
[FeedError]()
[FeedItemError]()
[FeedItemSetError]()
[FieldError]()
[FieldMaskError]()
[FunctionParsingError]()
[HeaderError]()
[ImageError]()
[InternalError]()
[KeywordPlanAdGroupKeywordError]()
[KeywordPlanCampaignError]()
[KeywordPlanError]()
[LabelError]()
[ListOperationError]()
[MediaUploadError]()
[MutateError]()
[NewResourceCreationError]()
[NullError]()
[OperationAccessDeniedError]()
[PolicyFindingError]()
[PolicyViolationError]()
[QuotaError]()
[RangeError]()
[RequestError]()
[ResourceCountLimitExceededError]()
[SettingError]()
[SharedSetError]()
[SizeLimitError]()
[StringFormatError]()
[StringLengthError]()
[UrlFieldError]()
[UserListError]()
[YoutubeVideoRegistrationError]()

@overload mutate(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::Services::MutateGoogleAdsRequest, ::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(customer_id: nil, mutate_operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil)

Pass arguments to `mutate` 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. The ID of the customer whose resources are being modified.
@param mutate_operations [::Array<::Google::Ads::GoogleAds::V7::Services::MutateOperation, ::Hash>]
  Required. The list of operations to perform on individual resources.
@param partial_failure [::Boolean]
  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.
@param validate_only [::Boolean]
  If true, the request is validated but not executed. Only errors are
  returned, not results.
@param response_content_type [::Google::Ads::GoogleAds::V7::Enums::ResponseContentTypeEnum::ResponseContentType]
  The response content type setting. Determines whether the mutable resource
  or just the resource name should be returned post mutation. The mutable
  resource will only be returned if the resource has the appropriate response
  field. E.g. MutateCampaignResult.campaign.

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

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

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

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

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

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

  @google_ads_service_stub.call_rpc :mutate, 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
search_stream(request, options = nil) { |response, operation| ... } click to toggle source

Returns all rows that match the search stream query.

List of thrown errors:

[AuthenticationError]()
[AuthorizationError]()
[ChangeEventError]()
[ChangeStatusError]()
[ClickViewError]()
[HeaderError]()
[InternalError]()
[QueryError]()
[QuotaError]()
[RequestError]()

@overload search_stream(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V7::Services::SearchGoogleAdsStreamRequest, ::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 search_stream(customer_id: nil, query: nil, summary_row_setting: nil)

Pass arguments to `search_stream` 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. The ID of the customer being queried.
@param query [::String]
  Required. The query string.
@param summary_row_setting [::Google::Ads::GoogleAds::V7::Enums::SummaryRowSettingEnum::SummaryRowSetting]
  Determines whether a summary row will be returned. By default, summary row
  is not returned. If requested, the summary row will be sent in a response
  by itself after all other query results are returned.

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

@return [::Enumerable<::Google::Ads::GoogleAds::V7::Services::SearchGoogleAdsStreamResponse>]

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

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

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

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

  @google_ads_service_stub.call_rpc :search_stream, 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