class Google::Ads::GoogleAds::V8::Services::CampaignAssetService::Client

Client for the CampaignAssetService service.

Service to manage campaign assets.

Attributes

campaign_asset_service_stub[R]

@private

Public Class Methods

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

Configure the CampaignAssetService Client class.

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

@example

# Modify the configuration for all CampaignAssetService clients
::Google::Ads::GoogleAds::V8::Services::CampaignAssetService::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/v8/services/campaign_asset_service/client.rb, line 57
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 CampaignAssetService client object.

@example

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

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

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

# File lib/google/ads/google_ads/v8/services/campaign_asset_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/v8/services/campaign_asset_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 == 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

  @campaign_asset_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Ads::GoogleAds::V8::Services::CampaignAssetService::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 CampaignAssetService 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::V8::Services::CampaignAssetService::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/v8/services/campaign_asset_service/client.rb, line 87
def configure
  yield @config if block_given?
  @config
end
get_campaign_asset(request, options = nil) { |response, operation| ... } click to toggle source

Returns the requested campaign asset in full detail.

List of thrown errors:

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

@overload get_campaign_asset(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V8::Services::GetCampaignAssetRequest, ::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 get_campaign_asset(resource_name: nil)

Pass arguments to `get_campaign_asset` 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 resource_name [::String]
  Required. The resource name of the campaign asset to fetch.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Ads::GoogleAds::V8::Resources::CampaignAsset] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Ads::GoogleAds::V8::Resources::CampaignAsset]

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

# File lib/google/ads/google_ads/v8/services/campaign_asset_service/client.rb, line 183
def get_campaign_asset request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::GetCampaignAssetRequest

  # 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_campaign_asset.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_campaign_asset.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_campaign_asset.retry_policy

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

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

Creates, updates, or removes campaign assets. Operation statuses are returned.

List of thrown errors:

[AssetLinkError]()
[AuthenticationError]()
[AuthorizationError]()
[ContextError]()
[DatabaseError]()
[FieldError]()
[HeaderError]()
[InternalError]()
[MutateError]()
[NotAllowlistedError]()
[QuotaError]()
[RequestError]()

@overload mutate_campaign_assets(request, options = nil)

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

@param request [::Google::Ads::GoogleAds::V8::Services::MutateCampaignAssetsRequest, ::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_campaign_assets(customer_id: nil, operations: nil, partial_failure: nil, validate_only: nil, response_content_type: nil)

Pass arguments to `mutate_campaign_assets` 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 campaign assets are being modified.
@param operations [::Array<::Google::Ads::GoogleAds::V8::Services::CampaignAssetOperation, ::Hash>]
  Required. The list of operations to perform on individual campaign assets.
@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::V8::Enums::ResponseContentTypeEnum::ResponseContentType]
  The response content type setting. Determines whether the mutable resource
  or just the resource name should be returned post mutation.

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

@return [::Google::Ads::GoogleAds::V8::Services::MutateCampaignAssetsResponse]

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

# File lib/google/ads/google_ads/v8/services/campaign_asset_service/client.rb, line 281
def mutate_campaign_assets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request,
                                     to: ::Google::Ads::GoogleAds::V8::Services::MutateCampaignAssetsRequest

  # 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_campaign_assets.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_campaign_assets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.mutate_campaign_assets.retry_policy

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

  @campaign_asset_service_stub.call_rpc :mutate_campaign_assets, 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