google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
136 lines (135 loc) • 6.7 kB
TypeScript
import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
import type { GenerateAudienceCompositionInsightsResponse } from "./audience_insights_service";
import type { GenerateAudienceCompositionInsightsRequest } from "./audience_insights_service";
import type { ListAudienceInsightsAttributesResponse } from "./audience_insights_service";
import type { ListAudienceInsightsAttributesRequest } from "./audience_insights_service";
import type { GenerateInsightsFinderReportResponse } from "./audience_insights_service";
import type { GenerateInsightsFinderReportRequest } from "./audience_insights_service";
import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
/**
* Audience Insights Service helps users find information about groups of
* people and how they can be reached with Google Ads.
*
* @generated from protobuf service google.ads.googleads.v11.services.AudienceInsightsService
*/
export interface IAudienceInsightsServiceClient {
/**
* 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]()
*
* @generated from protobuf rpc: GenerateInsightsFinderReport(google.ads.googleads.v11.services.GenerateInsightsFinderReportRequest) returns (google.ads.googleads.v11.services.GenerateInsightsFinderReportResponse);
*/
generateInsightsFinderReport(input: GenerateInsightsFinderReportRequest, options?: RpcOptions): UnaryCall<GenerateInsightsFinderReportRequest, GenerateInsightsFinderReportResponse>;
/**
* Searches for audience attributes that can be used to generate insights.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [FieldError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
*
* @generated from protobuf rpc: ListAudienceInsightsAttributes(google.ads.googleads.v11.services.ListAudienceInsightsAttributesRequest) returns (google.ads.googleads.v11.services.ListAudienceInsightsAttributesResponse);
*/
listAudienceInsightsAttributes(input: ListAudienceInsightsAttributesRequest, options?: RpcOptions): UnaryCall<ListAudienceInsightsAttributesRequest, ListAudienceInsightsAttributesResponse>;
/**
* 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]()
*
* @generated from protobuf rpc: GenerateAudienceCompositionInsights(google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsRequest) returns (google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsResponse);
*/
generateAudienceCompositionInsights(input: GenerateAudienceCompositionInsightsRequest, options?: RpcOptions): UnaryCall<GenerateAudienceCompositionInsightsRequest, GenerateAudienceCompositionInsightsResponse>;
}
/**
* Audience Insights Service helps users find information about groups of
* people and how they can be reached with Google Ads.
*
* @generated from protobuf service google.ads.googleads.v11.services.AudienceInsightsService
*/
export declare class AudienceInsightsServiceClient implements IAudienceInsightsServiceClient, 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 a saved report that can be viewed in the Insights Finder tool.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [FieldError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
*
* @generated from protobuf rpc: GenerateInsightsFinderReport(google.ads.googleads.v11.services.GenerateInsightsFinderReportRequest) returns (google.ads.googleads.v11.services.GenerateInsightsFinderReportResponse);
*/
generateInsightsFinderReport(input: GenerateInsightsFinderReportRequest, options?: RpcOptions): UnaryCall<GenerateInsightsFinderReportRequest, GenerateInsightsFinderReportResponse>;
/**
* Searches for audience attributes that can be used to generate insights.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [FieldError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
*
* @generated from protobuf rpc: ListAudienceInsightsAttributes(google.ads.googleads.v11.services.ListAudienceInsightsAttributesRequest) returns (google.ads.googleads.v11.services.ListAudienceInsightsAttributesResponse);
*/
listAudienceInsightsAttributes(input: ListAudienceInsightsAttributesRequest, options?: RpcOptions): UnaryCall<ListAudienceInsightsAttributesRequest, ListAudienceInsightsAttributesResponse>;
/**
* 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]()
*
* @generated from protobuf rpc: GenerateAudienceCompositionInsights(google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsRequest) returns (google.ads.googleads.v11.services.GenerateAudienceCompositionInsightsResponse);
*/
generateAudienceCompositionInsights(input: GenerateAudienceCompositionInsightsRequest, options?: RpcOptions): UnaryCall<GenerateAudienceCompositionInsightsRequest, GenerateAudienceCompositionInsightsResponse>;
}