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

Googleads client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service to generate keyword ideas.
 * @class
 * @memberof v21
 */
export declare class KeywordPlanIdeaServiceClient {
    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;
    };
    keywordPlanIdeaServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of KeywordPlanIdeaServiceClient.
     *
     * @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 KeywordPlanIdeaServiceClient({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;
    /**
     * Returns a list of keyword historical metrics.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [CollectionSizeError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   The ID of the customer with the recommendation.
     * @param {string[]} request.keywords
     *   A list of keywords to get historical metrics.
     *   Not all inputs will be returned as a result of near-exact deduplication.
     *   For example, if stats for "car" and "cars" are requested, only "car" will
     *   be returned.
     *   A maximum of 10,000 keywords can be used.
     * @param {string} request.language
     *   The resource name of the language to target.
     *   Each keyword belongs to some set of languages; a keyword is included if
     *   language is one of its languages.
     *   If not set, all keywords will be included.
     * @param {boolean} request.includeAdultKeywords
     *   If true, adult keywords will be included in response.
     *   The default value is false.
     * @param {string[]} request.geoTargetConstants
     *   The resource names of the location to target. Maximum is 10.
     *   An empty list MAY be used to specify all targeting geos.
     * @param {google.ads.googleads.v21.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork} request.keywordPlanNetwork
     *   Targeting network.
     *   If not set, Google Search And Partners Network will be used.
     * @param {google.ads.googleads.v21.common.KeywordPlanAggregateMetrics} request.aggregateMetrics
     *   The aggregate fields to include in response.
     * @param {google.ads.googleads.v21.common.HistoricalMetricsOptions} request.historicalMetricsOptions
     *   The options for historical metrics data.
     * @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.GenerateKeywordHistoricalMetricsResponse|GenerateKeywordHistoricalMetricsResponse}.
     *   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/keyword_plan_idea_service.generate_keyword_historical_metrics.js</caption>
     * region_tag:googleads_v21_generated_KeywordPlanIdeaService_GenerateKeywordHistoricalMetrics_async
     */
    generateKeywordHistoricalMetrics(request?: protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsResponse,
        protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest | undefined,
        {} | undefined
    ]>;
    generateKeywordHistoricalMetrics(request: protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest | null | undefined, {} | null | undefined>): void;
    generateKeywordHistoricalMetrics(request: protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateKeywordHistoricalMetricsRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns a list of suggested AdGroups and suggested modifications
     * (text, match type) for the given keywords.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [CollectionSizeError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   Required. The ID of the customer.
     * @param {string[]} request.keywords
     *   Required. A list of keywords to group into the provided AdGroups.
     * @param {string[]} request.adGroups
     *   Required. A list of resource names of AdGroups to group keywords into.
     *    Resource name format: `customers/{customer_id}/adGroups/{ad_group_id}`
     * @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.GenerateAdGroupThemesResponse|GenerateAdGroupThemesResponse}.
     *   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/keyword_plan_idea_service.generate_ad_group_themes.js</caption>
     * region_tag:googleads_v21_generated_KeywordPlanIdeaService_GenerateAdGroupThemes_async
     */
    generateAdGroupThemes(request?: protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesResponse,
        protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest | undefined,
        {} | undefined
    ]>;
    generateAdGroupThemes(request: protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesResponse, protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest | null | undefined, {} | null | undefined>): void;
    generateAdGroupThemes(request: protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesResponse, protos.google.ads.googleads.v21.services.IGenerateAdGroupThemesRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Returns metrics (such as impressions, clicks, total cost) of a keyword
     * forecast for the given campaign.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [CollectionSizeError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   The ID of the customer.
     * @param {string} request.currencyCode
     *   The currency used for exchange rate conversion.
     *   By default, the account currency of the customer is used.
     *   Set this field only if the currency is different from the account currency.
     *   The list of valid currency codes can be found at
     *   https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
     * @param {google.ads.googleads.v21.common.DateRange} request.forecastPeriod
     *   The date range for the forecast. The start date must be in the future and
     *   end date must be within 1 year from today. The reference timezone used is
     *   the one of the Google Ads account belonging to the customer. If not set, a
     *   default date range from next Sunday to the following Saturday will be used.
     * @param {google.ads.googleads.v21.services.CampaignToForecast} request.campaign
     *   Required. The campaign used in the forecast.
     * @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.GenerateKeywordForecastMetricsResponse|GenerateKeywordForecastMetricsResponse}.
     *   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/keyword_plan_idea_service.generate_keyword_forecast_metrics.js</caption>
     * region_tag:googleads_v21_generated_KeywordPlanIdeaService_GenerateKeywordForecastMetrics_async
     */
    generateKeywordForecastMetrics(request?: protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsResponse,
        protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest | undefined,
        {} | undefined
    ]>;
    generateKeywordForecastMetrics(request: protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest, options: CallOptions, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest | null | undefined, {} | null | undefined>): void;
    generateKeywordForecastMetrics(request: protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest, callback: Callback<protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsResponse, protos.google.ads.googleads.v21.services.IGenerateKeywordForecastMetricsRequest | null | undefined, {} | null | undefined>): void;
    /**
    * Returns a list of keyword ideas.
    *
    * List of thrown errors:
    *   [AuthenticationError]()
    *   [AuthorizationError]()
    *   [CollectionSizeError]()
    *   [HeaderError]()
    *   [InternalError]()
    *   [KeywordPlanIdeaError]()
    *   [QuotaError]()
    *   [RequestError]()
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.customerId
    *   The ID of the customer with the recommendation.
    * @param {string} request.language
    *   The resource name of the language to target.
    *   Each keyword belongs to some set of languages; a keyword is included if
    *   language is one of its languages.
    *   If not set, all keywords will be included.
    * @param {string[]} request.geoTargetConstants
    *   The resource names of the location to target. Maximum is 10.
    *   An empty list MAY be used to specify all targeting geos.
    * @param {boolean} request.includeAdultKeywords
    *   If true, adult keywords will be included in response.
    *   The default value is false.
    * @param {string} request.pageToken
    *   Token of the page to retrieve. If not specified, the first
    *   page of results will be returned. To request next page of results use the
    *   value obtained from `next_page_token` in the previous response.
    *   The request fields must match across pages.
    * @param {number} request.pageSize
    *   Number of results to retrieve in a single page.
    *   A maximum of 10,000 results may be returned, if the page_size
    *   exceeds this, it is ignored.
    *   If unspecified, at most 10,000 results will be returned.
    *   The server may decide to further limit the number of returned resources.
    *   If the response contains fewer than 10,000 results it may not be assumed
    *   as last page of results.
    * @param {google.ads.googleads.v21.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork} request.keywordPlanNetwork
    *   Targeting network.
    *   If not set, Google Search And Partners Network will be used.
    * @param {number[]} request.keywordAnnotation
    *   The keyword annotations to include in response.
    * @param {google.ads.googleads.v21.common.KeywordPlanAggregateMetrics} request.aggregateMetrics
    *   The aggregate fields to include in response.
    * @param {google.ads.googleads.v21.common.HistoricalMetricsOptions} request.historicalMetricsOptions
    *   The options for historical metrics data.
    * @param {google.ads.googleads.v21.services.KeywordAndUrlSeed} request.keywordAndUrlSeed
    *   A Keyword and a specific Url to generate ideas from
    *   for example, cars, www.example.com/cars.
    * @param {google.ads.googleads.v21.services.KeywordSeed} request.keywordSeed
    *   A Keyword or phrase to generate ideas from, for example, cars.
    * @param {google.ads.googleads.v21.services.UrlSeed} request.urlSeed
    *   A specific url to generate ideas from, for example, www.example.com/cars.
    * @param {google.ads.googleads.v21.services.SiteSeed} request.siteSeed
    *   The site to generate ideas from, for example, www.example.com.
    * @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 Array of {@link protos.google.ads.googleads.v21.services.GenerateKeywordIdeaResult|GenerateKeywordIdeaResult}.
    *   The client library will perform auto-pagination by default: it will call the API as many
    *   times as needed and will merge results from all the pages into this array.
    *   Note that it can affect your quota.
    *   We recommend using `generateKeywordIdeasAsync()`
    *   method described below for async iteration which you can stop as needed.
    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
    *   for more details and examples.
    */
    generateKeywordIdeas(request?: protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, options?: CallOptions): Promise<[
        protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResult[],
        protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest | null,
        protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResponse
    ]>;
    generateKeywordIdeas(request: protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResponse | null | undefined, protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResult>): void;
    generateKeywordIdeas(request: protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, callback: PaginationCallback<protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResponse | null | undefined, protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResult>): void;
    /**
     * Equivalent to `generateKeywordIdeas`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   The ID of the customer with the recommendation.
     * @param {string} request.language
     *   The resource name of the language to target.
     *   Each keyword belongs to some set of languages; a keyword is included if
     *   language is one of its languages.
     *   If not set, all keywords will be included.
     * @param {string[]} request.geoTargetConstants
     *   The resource names of the location to target. Maximum is 10.
     *   An empty list MAY be used to specify all targeting geos.
     * @param {boolean} request.includeAdultKeywords
     *   If true, adult keywords will be included in response.
     *   The default value is false.
     * @param {string} request.pageToken
     *   Token of the page to retrieve. If not specified, the first
     *   page of results will be returned. To request next page of results use the
     *   value obtained from `next_page_token` in the previous response.
     *   The request fields must match across pages.
     * @param {number} request.pageSize
     *   Number of results to retrieve in a single page.
     *   A maximum of 10,000 results may be returned, if the page_size
     *   exceeds this, it is ignored.
     *   If unspecified, at most 10,000 results will be returned.
     *   The server may decide to further limit the number of returned resources.
     *   If the response contains fewer than 10,000 results it may not be assumed
     *   as last page of results.
     * @param {google.ads.googleads.v21.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork} request.keywordPlanNetwork
     *   Targeting network.
     *   If not set, Google Search And Partners Network will be used.
     * @param {number[]} request.keywordAnnotation
     *   The keyword annotations to include in response.
     * @param {google.ads.googleads.v21.common.KeywordPlanAggregateMetrics} request.aggregateMetrics
     *   The aggregate fields to include in response.
     * @param {google.ads.googleads.v21.common.HistoricalMetricsOptions} request.historicalMetricsOptions
     *   The options for historical metrics data.
     * @param {google.ads.googleads.v21.services.KeywordAndUrlSeed} request.keywordAndUrlSeed
     *   A Keyword and a specific Url to generate ideas from
     *   for example, cars, www.example.com/cars.
     * @param {google.ads.googleads.v21.services.KeywordSeed} request.keywordSeed
     *   A Keyword or phrase to generate ideas from, for example, cars.
     * @param {google.ads.googleads.v21.services.UrlSeed} request.urlSeed
     *   A specific url to generate ideas from, for example, www.example.com/cars.
     * @param {google.ads.googleads.v21.services.SiteSeed} request.siteSeed
     *   The site to generate ideas from, for example, www.example.com.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing {@link protos.google.ads.googleads.v21.services.GenerateKeywordIdeaResult|GenerateKeywordIdeaResult} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `generateKeywordIdeasAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    generateKeywordIdeasStream(request?: protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `generateKeywordIdeas`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.customerId
     *   The ID of the customer with the recommendation.
     * @param {string} request.language
     *   The resource name of the language to target.
     *   Each keyword belongs to some set of languages; a keyword is included if
     *   language is one of its languages.
     *   If not set, all keywords will be included.
     * @param {string[]} request.geoTargetConstants
     *   The resource names of the location to target. Maximum is 10.
     *   An empty list MAY be used to specify all targeting geos.
     * @param {boolean} request.includeAdultKeywords
     *   If true, adult keywords will be included in response.
     *   The default value is false.
     * @param {string} request.pageToken
     *   Token of the page to retrieve. If not specified, the first
     *   page of results will be returned. To request next page of results use the
     *   value obtained from `next_page_token` in the previous response.
     *   The request fields must match across pages.
     * @param {number} request.pageSize
     *   Number of results to retrieve in a single page.
     *   A maximum of 10,000 results may be returned, if the page_size
     *   exceeds this, it is ignored.
     *   If unspecified, at most 10,000 results will be returned.
     *   The server may decide to further limit the number of returned resources.
     *   If the response contains fewer than 10,000 results it may not be assumed
     *   as last page of results.
     * @param {google.ads.googleads.v21.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork} request.keywordPlanNetwork
     *   Targeting network.
     *   If not set, Google Search And Partners Network will be used.
     * @param {number[]} request.keywordAnnotation
     *   The keyword annotations to include in response.
     * @param {google.ads.googleads.v21.common.KeywordPlanAggregateMetrics} request.aggregateMetrics
     *   The aggregate fields to include in response.
     * @param {google.ads.googleads.v21.common.HistoricalMetricsOptions} request.historicalMetricsOptions
     *   The options for historical metrics data.
     * @param {google.ads.googleads.v21.services.KeywordAndUrlSeed} request.keywordAndUrlSeed
     *   A Keyword and a specific Url to generate ideas from
     *   for example, cars, www.example.com/cars.
     * @param {google.ads.googleads.v21.services.KeywordSeed} request.keywordSeed
     *   A Keyword or phrase to generate ideas from, for example, cars.
     * @param {google.ads.googleads.v21.services.UrlSeed} request.urlSeed
     *   A specific url to generate ideas from, for example, www.example.com/cars.
     * @param {google.ads.googleads.v21.services.SiteSeed} request.siteSeed
     *   The site to generate ideas from, for example, www.example.com.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
     *   When you iterate the returned iterable, each element will be an object representing
     *   {@link protos.google.ads.googleads.v21.services.GenerateKeywordIdeaResult|GenerateKeywordIdeaResult}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v21/keyword_plan_idea_service.generate_keyword_ideas.js</caption>
     * region_tag:googleads_v21_generated_KeywordPlanIdeaService_GenerateKeywordIdeas_async
     */
    generateKeywordIdeasAsync(request?: protos.google.ads.googleads.v21.services.IGenerateKeywordIdeasRequest, options?: CallOptions): AsyncIterable<protos.google.ads.googleads.v21.services.IGenerateKeywordIdeaResult>;
    /**
     * 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(customerId: string, adGroupId: string, criterionId: string): string;
    /**
     * Parse the customer_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGroupCriterion resource.
     * @returns {string} A string representing the customer_id.
     */
    matchCustomerIdFromAdGroupCriterionName(adGroupCriterionName: string): string | number;
    /**
     * Parse the ad_group_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGroupCriterion resource.
     * @returns {string} A string representing the ad_group_id.
     */
    matchAdGroupIdFromAdGroupCriterionName(adGroupCriterionName: string): string | number;
    /**
     * Parse the criterion_id from AdGroupCriterion resource.
     *
     * @param {string} adGroupCriterionName
     *   A fully-qualified path representing AdGr