google-ads-api-client/dist/protos/bindings/ads/services/keyword_plan_service.client.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
import type { GenerateHistoricalMetricsResponse } from "./keyword_plan_service";
import type { GenerateHistoricalMetricsRequest } from "./keyword_plan_service";
import type { GenerateForecastMetricsResponse } from "./keyword_plan_service";
import type { GenerateForecastMetricsRequest } from "./keyword_plan_service";
import type { GenerateForecastTimeSeriesResponse } from "./keyword_plan_service";
import type { GenerateForecastTimeSeriesRequest } from "./keyword_plan_service";
import type { GenerateForecastCurveResponse } from "./keyword_plan_service";
import type { GenerateForecastCurveRequest } from "./keyword_plan_service";
import type { MutateKeywordPlansResponse } from "./keyword_plan_service";
import type { MutateKeywordPlansRequest } from "./keyword_plan_service";
import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
/**
 * Service to manage keyword plans.
 *
 * @generated from protobuf service google.ads.googleads.v11.services.KeywordPlanService
 */
export interface IKeywordPlanServiceClient {
    /**
     * Creates, updates, or removes keyword plans. Operation statuses are
     * returned.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [DatabaseError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [MutateError]()
     *   [NewResourceCreationError]()
     *   [QuotaError]()
     *   [RequestError]()
     *   [ResourceCountLimitExceededError]()
     *   [StringLengthError]()
     *
     * @generated from protobuf rpc: MutateKeywordPlans(google.ads.googleads.v11.services.MutateKeywordPlansRequest) returns (google.ads.googleads.v11.services.MutateKeywordPlansResponse);
     */
    mutateKeywordPlans(input: MutateKeywordPlansRequest, options?: RpcOptions): UnaryCall<MutateKeywordPlansRequest, MutateKeywordPlansResponse>;
    /**
     * Returns the requested Keyword Plan forecast curve.
     * Only the bidding strategy is considered for generating forecast curve.
     * The bidding strategy value specified in the plan is ignored.
     *
     * To generate a forecast at a value specified in the plan, use
     * KeywordPlanService.GenerateForecastMetrics.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastCurve(google.ads.googleads.v11.services.GenerateForecastCurveRequest) returns (google.ads.googleads.v11.services.GenerateForecastCurveResponse);
     */
    generateForecastCurve(input: GenerateForecastCurveRequest, options?: RpcOptions): UnaryCall<GenerateForecastCurveRequest, GenerateForecastCurveResponse>;
    /**
     * Returns a forecast in the form of a time series for the Keyword Plan over
     * the next 52 weeks.
     * (1) Forecasts closer to the current date are generally more accurate than
     * further out.
     *
     * (2) The forecast reflects seasonal trends using current and
     * prior traffic patterns. The forecast period of the plan is ignored.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastTimeSeries(google.ads.googleads.v11.services.GenerateForecastTimeSeriesRequest) returns (google.ads.googleads.v11.services.GenerateForecastTimeSeriesResponse);
     */
    generateForecastTimeSeries(input: GenerateForecastTimeSeriesRequest, options?: RpcOptions): UnaryCall<GenerateForecastTimeSeriesRequest, GenerateForecastTimeSeriesResponse>;
    /**
     * Returns the requested Keyword Plan forecasts.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastMetrics(google.ads.googleads.v11.services.GenerateForecastMetricsRequest) returns (google.ads.googleads.v11.services.GenerateForecastMetricsResponse);
     */
    generateForecastMetrics(input: GenerateForecastMetricsRequest, options?: RpcOptions): UnaryCall<GenerateForecastMetricsRequest, GenerateForecastMetricsResponse>;
    /**
     * Returns the requested Keyword Plan historical metrics.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateHistoricalMetrics(google.ads.googleads.v11.services.GenerateHistoricalMetricsRequest) returns (google.ads.googleads.v11.services.GenerateHistoricalMetricsResponse);
     */
    generateHistoricalMetrics(input: GenerateHistoricalMetricsRequest, options?: RpcOptions): UnaryCall<GenerateHistoricalMetricsRequest, GenerateHistoricalMetricsResponse>;
}
/**
 * Service to manage keyword plans.
 *
 * @generated from protobuf service google.ads.googleads.v11.services.KeywordPlanService
 */
export declare class KeywordPlanServiceClient implements IKeywordPlanServiceClient, ServiceInfo {
    private readonly _transport;
    typeName: string;
    methods: import("@protobuf-ts/runtime-rpc").MethodInfo<any, any>[];
    options: {
        [extensionName: string]: import("@protobuf-ts/runtime").JsonValue;
    };
    constructor(_transport: RpcTransport);
    /**
     * Creates, updates, or removes keyword plans. Operation statuses are
     * returned.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [DatabaseError]()
     *   [FieldError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [MutateError]()
     *   [NewResourceCreationError]()
     *   [QuotaError]()
     *   [RequestError]()
     *   [ResourceCountLimitExceededError]()
     *   [StringLengthError]()
     *
     * @generated from protobuf rpc: MutateKeywordPlans(google.ads.googleads.v11.services.MutateKeywordPlansRequest) returns (google.ads.googleads.v11.services.MutateKeywordPlansResponse);
     */
    mutateKeywordPlans(input: MutateKeywordPlansRequest, options?: RpcOptions): UnaryCall<MutateKeywordPlansRequest, MutateKeywordPlansResponse>;
    /**
     * Returns the requested Keyword Plan forecast curve.
     * Only the bidding strategy is considered for generating forecast curve.
     * The bidding strategy value specified in the plan is ignored.
     *
     * To generate a forecast at a value specified in the plan, use
     * KeywordPlanService.GenerateForecastMetrics.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastCurve(google.ads.googleads.v11.services.GenerateForecastCurveRequest) returns (google.ads.googleads.v11.services.GenerateForecastCurveResponse);
     */
    generateForecastCurve(input: GenerateForecastCurveRequest, options?: RpcOptions): UnaryCall<GenerateForecastCurveRequest, GenerateForecastCurveResponse>;
    /**
     * Returns a forecast in the form of a time series for the Keyword Plan over
     * the next 52 weeks.
     * (1) Forecasts closer to the current date are generally more accurate than
     * further out.
     *
     * (2) The forecast reflects seasonal trends using current and
     * prior traffic patterns. The forecast period of the plan is ignored.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastTimeSeries(google.ads.googleads.v11.services.GenerateForecastTimeSeriesRequest) returns (google.ads.googleads.v11.services.GenerateForecastTimeSeriesResponse);
     */
    generateForecastTimeSeries(input: GenerateForecastTimeSeriesRequest, options?: RpcOptions): UnaryCall<GenerateForecastTimeSeriesRequest, GenerateForecastTimeSeriesResponse>;
    /**
     * Returns the requested Keyword Plan forecasts.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateForecastMetrics(google.ads.googleads.v11.services.GenerateForecastMetricsRequest) returns (google.ads.googleads.v11.services.GenerateForecastMetricsResponse);
     */
    generateForecastMetrics(input: GenerateForecastMetricsRequest, options?: RpcOptions): UnaryCall<GenerateForecastMetricsRequest, GenerateForecastMetricsResponse>;
    /**
     * Returns the requested Keyword Plan historical metrics.
     *
     * List of thrown errors:
     *   [AuthenticationError]()
     *   [AuthorizationError]()
     *   [HeaderError]()
     *   [InternalError]()
     *   [KeywordPlanError]()
     *   [QuotaError]()
     *   [RequestError]()
     *
     * @generated from protobuf rpc: GenerateHistoricalMetrics(google.ads.googleads.v11.services.GenerateHistoricalMetricsRequest) returns (google.ads.googleads.v11.services.GenerateHistoricalMetricsResponse);
     */
    generateHistoricalMetrics(input: GenerateHistoricalMetricsRequest, options?: RpcOptions): UnaryCall<GenerateHistoricalMetricsRequest, GenerateHistoricalMetricsResponse>;
}