google-ads-nodejs-client/build/src/v21/audience_insights_service_client.d.ts

Googleads client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
import * as protos from '../../protos/protos';
/**
 *  Audience Insights Service helps users find information about groups of
 *  people and how they can be reached with Google Ads. Accessible to
 *  allowlisted customers only.
 * @class
 * @memberof v21
 */
export declare class AudienceInsightsServiceClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    audienceInsightsServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of AudienceInsightsServiceClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new AudienceInsightsServiceClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Creates a saved report that can be viewed in the Insights Finder tool.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {google.ads.googleads.v21.services.BasicInsightsAudience} request.baselineAudience
     *   Required. A baseline audience for this report, typically all people in a
     *   region.
     * @param {google.ads.googleads.v21.services.BasicInsightsAudience} request.specificAudience
     *   Required. The specific audience of interest for this report.  The insights
     *   in the report will be based on attributes more prevalent in this audience
     *   than in the report's baseline audience.
     * @param {string} request.customerInsightsGroup
     *   The name of the customer being planned for.  This is a user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.GenerateInsightsFinderReportResponse|GenerateInsightsFinderReportResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.generate_insights_finder_report.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_GenerateInsightsFinderReport_async
     */
    generateInsightsFinderReport(request?: protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportResponse,
        protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest | undefined,
        {} | undefined
    ]>;
    generateInsightsFinderReport(request: protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportResponse, protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest | null | undefined, {} | null | undefined>): void;
    generateInsightsFinderReport(request: protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportResponse, protos.google.ads.googleads.v21.services.IGenerateInsightsFinderReportRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Searches for audience attributes that can be used to generate insights.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {number[]} request.dimensions
     *   Required. The types of attributes to be returned. Supported
     *   dimensions are CATEGORY, KNOWLEDGE_GRAPH, DEVICE,
     *   GEO_TARGET_COUNTRY, SUB_COUNTRY_LOCATION, YOUTUBE_LINEUP,
     *   AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
     *   INCOME_RANGE, AGE_RANGE, and GENDER.
     * @param {string} request.queryText
     *   Required. A free text query.  If the requested dimensions include
     *   Attributes CATEGORY or KNOWLEDGE_GRAPH, then the attributes returned for
     *   those dimensions will match or be related to this string.  For other
     *   dimensions, this field is ignored and all available attributes are
     *   returned.
     * @param {string} request.customerInsightsGroup
     *   The name of the customer being planned for.  This is a user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {number[]} request.locationCountryFilters
     *   If SUB_COUNTRY_LOCATION attributes are one of the requested dimensions and
     *   this field is present, then the SUB_COUNTRY_LOCATION attributes returned
     *   will be located in these countries. If this field is absent, then location
     *   attributes are not filtered by country. Setting this field when
     *   SUB_COUNTRY_LOCATION attributes are not requested will return an error.
     * @param {google.ads.googleads.v21.common.LocationInfo} request.youtubeReachLocation
     *   If present, potential YouTube reach estimates within the specified market
     *   will be returned for attributes for which they are available.  Reach is
     *   only available for the AGE_RANGE, GENDER, AFFINITY_USER_INTEREST and
     *   IN_MARKET_USER_INTEREST dimensions, and may not be available for every
     *   attribute of those dimensions in every market.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.ListAudienceInsightsAttributesResponse|ListAudienceInsightsAttributesResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.list_audience_insights_attributes.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_ListAudienceInsightsAttributes_async
     */
    listAudienceInsightsAttributes(request?: protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesResponse,
        protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest | undefined,
        {} | undefined
    ]>;
    listAudienceInsightsAttributes(request: protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesResponse, protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest | null | undefined, {} | null | undefined>): void;
    listAudienceInsightsAttributes(request: protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest, callback: Callback<protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesResponse, protos.google.ads.googleads.v21.services.IListAudienceInsightsAttributesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Lists date ranges for which audience insights data can be requested.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.ListInsightsEligibleDatesResponse|ListInsightsEligibleDatesResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.list_insights_eligible_dates.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_ListInsightsEligibleDates_async
     */
    listInsightsEligibleDates(request?: protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesResponse,
        protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest | undefined,
        {} | undefined
    ]>;
    listInsightsEligibleDates(request: protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesResponse, protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest | null | undefined, {} | null | undefined>): void;
    listInsightsEligibleDates(request: protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest, callback: Callback<protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesResponse, protos.google.ads.googleads.v21.services.IListInsightsEligibleDatesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns a collection of attributes that are represented in an audience of
     * interest, with metrics that compare each attribute's share of the audience
     * with its share of a baseline audience.
     *
     * List of thrown errors:
     *   [AudienceInsightsError]()
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {google.ads.googleads.v21.services.InsightsAudience} request.audience
     *   Required. The audience of interest for which insights are being requested.
     * @param {google.ads.googleads.v21.services.InsightsAudience} request.baselineAudience
     *   The baseline audience to which the audience of interest is being
     *   compared.
     * @param {string} request.dataMonth
     *   The one-month range of historical data to use for insights, in the format
     *   "yyyy-mm". If unset, insights will be returned for the last thirty days of
     *   data.
     * @param {number[]} request.dimensions
     *   Required. The audience dimensions for which composition insights should be
     *   returned. Supported dimensions are KNOWLEDGE_GRAPH, GEO_TARGET_COUNTRY,
     *   SUB_COUNTRY_LOCATION, YOUTUBE_CHANNEL, YOUTUBE_LINEUP,
     *   AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, PARENTAL_STATUS,
     *   INCOME_RANGE, AGE_RANGE, and GENDER.
     * @param {string} request.customerInsightsGroup
     *   The name of the customer being planned for.  This is a user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.GenerateAudienceCompositionInsightsResponse|GenerateAudienceCompositionInsightsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.generate_audience_composition_insights.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_GenerateAudienceCompositionInsights_async
     */
    generateAudienceCompositionInsights(request?: protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsResponse,
        protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest | undefined,
        {} | undefined
    ]>;
    generateAudienceCompositionInsights(request: protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest | null | undefined, {} | null | undefined>): void;
    generateAudienceCompositionInsights(request: protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateAudienceCompositionInsightsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns a collection of targeting insights (e.g. targetable audiences) that
     * are relevant to the requested audience.
     *
     * List of thrown errors:
     *   [AudienceInsightsError]()
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {string} [request.customerInsightsGroup]
     *   Optional. The name of the customer being planned for.  This is a
     *   user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {google.ads.googleads.v21.services.InsightsAudienceDefinition} request.audienceDefinition
     *   Provide a seed audience to get suggestions for.
     * @param {google.ads.googleads.v21.services.InsightsAudienceDescription} request.audienceDescription
     *   Provide a text description of an audience to get AI-generated targeting
     *   suggestions. This can take around 5 or more seconds to complete.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.GenerateSuggestedTargetingInsightsResponse|GenerateSuggestedTargetingInsightsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.generate_suggested_targeting_insights.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_GenerateSuggestedTargetingInsights_async
     */
    generateSuggestedTargetingInsights(request?: protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsResponse,
        protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest | undefined,
        {} | undefined
    ]>;
    generateSuggestedTargetingInsights(request: protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest | null | undefined, {} | null | undefined>): void;
    generateSuggestedTargetingInsights(request: protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateSuggestedTargetingInsightsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns a collection of audience attributes along with estimates of the
     * overlap between their potential YouTube reach and that of a given input
     * attribute.
     *
     * List of thrown errors:
     *   [AudienceInsightsError]()
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {google.ads.googleads.v21.common.LocationInfo} request.countryLocation
     *   Required. The country in which to calculate the sizes and overlaps of
     *   audiences.
     * @param {google.ads.googleads.v21.common.AudienceInsightsAttribute} request.primaryAttribute
     *   Required. The audience attribute that should be intersected with all other
     *   eligible audiences.  This must be an Affinity or In-Market UserInterest, an
     *   AgeRange or a Gender.
     * @param {number[]} request.dimensions
     *   Required. The types of attributes of which to calculate the overlap with
     *   the primary_attribute. The values must be a subset of
     *   AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
     * @param {string} request.customerInsightsGroup
     *   The name of the customer being planned for.  This is a user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.GenerateAudienceOverlapInsightsResponse|GenerateAudienceOverlapInsightsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.generate_audience_overlap_insights.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_GenerateAudienceOverlapInsights_async
     */
    generateAudienceOverlapInsights(request?: protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsResponse,
        protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest | undefined,
        {} | undefined
    ]>;
    generateAudienceOverlapInsights(request: protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest | null | undefined, {} | null | undefined>): void;
    generateAudienceOverlapInsights(request: protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsResponse, protos.google.ads.googleads.v21.services.IGenerateAudienceOverlapInsightsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns potential reach metrics for targetable audiences.
     *
     * This method helps answer questions like "How many Men aged 18+ interested
     * in Camping can be reached on YouTube?"
     *
     * List of thrown errors:
     *   [AudienceInsightsError]()
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RangeError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {number[]} request.audiences
     *   Required. Audiences to request metrics for.
     * @param {string} [request.customerInsightsGroup]
     *   Optional. The name of the customer being planned for.  This is a
     *   user-defined value.
     * @param {google.ads.googleads.v21.common.AdditionalApplicationInfo} [request.insightsApplicationInfo]
     *   Optional. Additional information on the application issuing the request.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.ads.googleads.v21.services.GenerateTargetingSuggestionMetricsResponse|GenerateTargetingSuggestionMetricsResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/audience_insights_service.generate_targeting_suggestion_metrics.js</caption>
     * region_tag:googleads_v21_generated_AudienceInsightsService_GenerateTargetingSuggestionMetrics_async
     */
    generateTargetingSuggestionMetrics(request?: protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsResponse,
        protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest | undefined,
        {} | undefined
    ]>;
    generateTargetingSuggestionMetrics(request: protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest | null | undefined, {} | null | undefined>): void;
    generateTargetingSuggestionMetrics(request: protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateTargetingSuggestionMetricsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Return a fully-qualified accessibleBiddingStrategy resource name string.
     *
     * @param {string} customer_id
     * @param {string} bidding_strategy_id
     * @returns {string} Resource name string.
     */
    accessibleBiddingStrategyPath(customerId: string, biddingStrategyId: string): string;
    /**
     * Parse the customer_id from AccessibleBiddingStrategy resource.
     *
     * @param {string} accessibleBiddingStrategyName
     *   A fully-qualified path representing AccessibleBiddingStrategy resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccessibleBiddingStrategyName(accessibleBiddingStrategyName: string): string | number;
    /**
     * Parse the bidding_strategy_id from AccessibleBiddingStrategy resource.
     *
     * @param {string} accessibleBiddingStrategyName
     *   A fully-qualified path representing AccessibleBiddingStrategy resource.
     * @returns {string} A string representing the bidding_strategy_id.
     */
    matchBiddingStrategyIdFromAccessibleBiddingStrategyName(accessibleBiddingStrategyName: string): string | number;
    /**
     * Return a fully-qualified accountBudget resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_budget_id
     * @returns {string} Resource name string.
     */
    accountBudgetPath(customerId: string, accountBudgetId: string): string;
    /**
     * Parse the customer_id from AccountBudget resource.
     *
     * @param {string} accountBudgetName
     *   A fully-qualified path representing AccountBudget resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountBudgetName(accountBudgetName: string): string | number;
    /**
     * Parse the account_budget_id from AccountBudget resource.
     *
     * @param {string} accountBudgetName
     *   A fully-qualified path representing AccountBudget resource.
     * @returns {string} A string representing the account_budget_id.
     */
    matchAccountBudgetIdFromAccountBudgetName(accountBudgetName: string): string | number;
    /**
     * Return a fully-qualified accountBudgetProposal resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_budget_proposal_id
     * @returns {string} Resource name string.
     */
    accountBudgetProposalPath(customerId: string, accountBudgetProposalId: string): string;
    /**
     * Parse the customer_id from AccountBudgetProposal resource.
     *
     * @param {string} accountBudgetProposalName
     *   A fully-qualified path representing AccountBudgetProposal resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountBudgetProposalName(accountBudgetProposalName: string): string | number;
    /**
     * Parse the account_budget_proposal_id from AccountBudgetProposal resource.
     *
     * @param {string} accountBudgetProposalName
     *   A fully-qualified path representing AccountBudgetProposal resource.
     * @returns {string} A string representing the account_budget_proposal_id.
     */
    matchAccountBudgetProposalIdFromAccountBudgetProposalName(accountBudgetProposalName: string): string | number;
    /**
     * Return a fully-qualified accountLink resource name string.
     *
     * @param {string} customer_id
     * @param {string} account_link_id
     * @returns {string} Resource name string.
     */
    accountLinkPath(customerId: string, accountLinkId: string): string;
    /**
     * Parse the customer_id from AccountLink resource.
     *
     * @param {string} accountLinkName
     *   A fully-qualified path representing AccountLink resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAccountLinkName(accountLinkName: string): string | number;
    /**
     * Parse the account_link_id from AccountLink resource.
     *
     * @param {string} accountLinkName
     *   A fully-qualified path representing AccountLink resource.
     * @returns {string} A string representing the account_link_id.
     */
    matchAccountLinkIdFromAccountLinkName(accountLinkName: string): string | number;
    /**
     * Return a fully-qualified ad resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_id
     * @returns {string} Resource name string.
     */
    adPath(customerId: string, adId: string): string;
    /**
     * Parse the customer_id from Ad resource.
     *
     * @param {string} adName
     *   A fully-qualified path representing Ad resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdName(adName: string): string | number;
    /**
     * Parse the ad_id from Ad resource.
     *
     * @param {string} adName
     *   A fully-qualified path representing Ad resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdName(adName: string): string | number;
    /**
     * Return a fully-qualified adGroup resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @returns {string} Resource name string.
     */
    adGroupPath(customerId: string, adGroupId: string): string;
    /**
     * Parse the customer_id from AdGroup resource.
     *
     * @param {string} adGroupName
     *   A fully-qualified path representing AdGroup resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupName(adGroupName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroup resource.
     *
     * @param {string} adGroupName
     *   A fully-qualified path representing AdGroup resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupName(adGroupName: string): string | number;
    /**
     * Return a fully-qualified adGroupAd resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @returns {string} Resource name string.
     */
    adGroupAdPath(customerId: string, adGroupId: string, adId: string): string;
    /**
     * Parse the customer_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAd resource.
     *
     * @param {string} adGroupAdName
     *   A fully-qualified path representing AdGroupAd resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdName(adGroupAdName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdAssetCombinationView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} asset_combination_id_low
     * @param {string} asset_combination_id_high
     * @returns {string} Resource name string.
     */
    adGroupAdAssetCombinationViewPath(customerId: string, adGroupId: string, adId: string, assetCombinationIdLow: string, assetCombinationIdHigh: string): string;
    /**
     * Parse the customer_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the asset_combination_id_low from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the asset_combination_id_low.
     */
    matchAssetCombinationIdLowFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Parse the asset_combination_id_high from AdGroupAdAssetCombinationView resource.
     *
     * @param {string} adGroupAdAssetCombinationViewName
     *   A fully-qualified path representing AdGroupAdAssetCombinationView resource.
     * @returns {string} A string representing the asset_combination_id_high.
     */
    matchAssetCombinationIdHighFromAdGroupAdAssetCombinationViewName(adGroupAdAssetCombinationViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdAssetView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} asset_id
     * @param {string} field_type
     * @returns {string} Resource name string.
     */
    adGroupAdAssetViewPath(customerId: string, adGroupId: string, adId: string, assetId: string, fieldType: string): string;
    /**
     * Parse the customer_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the asset_id from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the asset_id.
     */
    matchAssetIdFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Parse the field_type from AdGroupAdAssetView resource.
     *
     * @param {string} adGroupAdAssetViewName
     *   A fully-qualified path representing AdGroupAdAssetView resource.
     * @returns {string} A string representing the field_type.
     */
    matchFieldTypeFromAdGroupAdAssetViewName(adGroupAdAssetViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupAdLabel resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} ad_id
     * @param {string} label_id
     * @returns {string} Resource name string.
     */
    adGroupAdLabelPath(customerId: string, adGroupId: string, adId: string, labelId: string): string;
    /**
     * Parse the customer_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the ad_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the ad_id.
     */
    matchAdIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Parse the label_id from AdGroupAdLabel resource.
     *
     * @param {string} adGroupAdLabelName
     *   A fully-qualified path representing AdGroupAdLabel resource.
     * @returns {string} A string representing the label_id.
     */
    matchLabelIdFromAdGroupAdLabelName(adGroupAdLabelName: string): string | number;
    /**
     * Return a fully-qualified adGroupAsset resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} asset_id
     * @param {string} field_type
     * @returns {string} Resource name string.
     */
    adGroupAssetPath(customerId: string, adGroupId: string, assetId: string, fieldType: string): string;
    /**
     * Parse the customer_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the asset_id from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the asset_id.
     */
    matchAssetIdFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Parse the field_type from AdGroupAsset resource.
     *
     * @param {string} adGroupAssetName
     *   A fully-qualified path representing AdGroupAsset resource.
     * @returns {string} A string representing the field_type.
     */
    matchFieldTypeFromAdGroupAssetName(adGroupAssetName: string): string | number;
    /**
     * Return a fully-qualified adGroupAssetSet resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} asset_set_id
     * @returns {string} Resource name string.
     */
    adGroupAssetSetPath(customerId: string, adGroupId: string, assetSetId: string): string;
    /**
     * Parse the customer_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Parse the asset_set_id from AdGroupAssetSet resource.
     *
     * @param {string} adGroupAssetSetName
     *   A fully-qualified path representing AdGroupAssetSet resource.
     * @returns {string} A string representing the asset_set_id.
     */
    matchAssetSetIdFromAdGroupAssetSetName(adGroupAssetSetName: string): string | number;
    /**
     * Return a fully-qualified adGroupAudienceView resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupAudienceViewPath(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupAudienceView resource.
     *
     * @param {string} adGroupAudienceViewName
     *   A fully-qualified path representing AdGroupAudienceView resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupAudienceViewName(adGroupAudienceViewName: string): string | number;
    /**
     * Return a fully-qualified adGroupBidModifier resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupBidModifierPath(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupBidModifier resource.
     *
     * @param {string} adGroupBidModifierName
     *   A fully-qualified path representing AdGroupBidModifier resource.
     * @returns {string} A string representing the criterion_id.
     */
    matchCriterionIdFromAdGroupBidModifierName(adGroupBidModifierName: string): string | number;
    /**
     * Return a fully-qualified adGroupCriterion resource name string.
     *
     * @param {string} customer_id
     * @param {string} ad_group_id
     * @param {string} criterion_id
     * @returns {string} Resource name string.
     */
    adGroupCriterionPath(customer