google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
152 lines (151 loc) • 5.16 kB
TypeScript
import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
import type { MutateAdsResponse } from "./ad_service";
import type { MutateAdsRequest } from "./ad_service";
import type { Ad } from "../resources/ad";
import type { GetAdRequest } from "./ad_service";
import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
/**
* Service to manage ads.
*
* @generated from protobuf service google.ads.googleads.v11.services.AdService
*/
export interface IAdServiceClient {
/**
* Returns the requested ad in full detail.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: GetAd(google.ads.googleads.v11.services.GetAdRequest) returns (google.ads.googleads.v11.resources.Ad);
*/
getAd(input: GetAdRequest, options?: RpcOptions): UnaryCall<GetAdRequest, Ad>;
/**
* Updates ads. Operation statuses are returned. Updating ads is not supported
* for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.
*
* List of thrown errors:
* [AdCustomizerError]()
* [AdError]()
* [AdSharingError]()
* [AdxError]()
* [AssetError]()
* [AssetLinkError]()
* [AuthenticationError]()
* [AuthorizationError]()
* [CollectionSizeError]()
* [DatabaseError]()
* [DateError]()
* [DistinctError]()
* [FeedAttributeReferenceError]()
* [FieldError]()
* [FieldMaskError]()
* [FunctionError]()
* [FunctionParsingError]()
* [HeaderError]()
* [IdError]()
* [ImageError]()
* [InternalError]()
* [ListOperationError]()
* [MediaBundleError]()
* [MediaFileError]()
* [MutateError]()
* [NewResourceCreationError]()
* [NotEmptyError]()
* [NullError]()
* [OperatorError]()
* [PolicyFindingError]()
* [PolicyViolationError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
* [SizeLimitError]()
* [StringFormatError]()
* [StringLengthError]()
* [UrlFieldError]()
*
* @generated from protobuf rpc: MutateAds(google.ads.googleads.v11.services.MutateAdsRequest) returns (google.ads.googleads.v11.services.MutateAdsResponse);
*/
mutateAds(input: MutateAdsRequest, options?: RpcOptions): UnaryCall<MutateAdsRequest, MutateAdsResponse>;
}
/**
* Service to manage ads.
*
* @generated from protobuf service google.ads.googleads.v11.services.AdService
*/
export declare class AdServiceClient implements IAdServiceClient, 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);
/**
* Returns the requested ad in full detail.
*
* List of thrown errors:
* [AuthenticationError]()
* [AuthorizationError]()
* [HeaderError]()
* [InternalError]()
* [QuotaError]()
* [RequestError]()
*
* @generated from protobuf rpc: GetAd(google.ads.googleads.v11.services.GetAdRequest) returns (google.ads.googleads.v11.resources.Ad);
*/
getAd(input: GetAdRequest, options?: RpcOptions): UnaryCall<GetAdRequest, Ad>;
/**
* Updates ads. Operation statuses are returned. Updating ads is not supported
* for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.
*
* List of thrown errors:
* [AdCustomizerError]()
* [AdError]()
* [AdSharingError]()
* [AdxError]()
* [AssetError]()
* [AssetLinkError]()
* [AuthenticationError]()
* [AuthorizationError]()
* [CollectionSizeError]()
* [DatabaseError]()
* [DateError]()
* [DistinctError]()
* [FeedAttributeReferenceError]()
* [FieldError]()
* [FieldMaskError]()
* [FunctionError]()
* [FunctionParsingError]()
* [HeaderError]()
* [IdError]()
* [ImageError]()
* [InternalError]()
* [ListOperationError]()
* [MediaBundleError]()
* [MediaFileError]()
* [MutateError]()
* [NewResourceCreationError]()
* [NotEmptyError]()
* [NullError]()
* [OperatorError]()
* [PolicyFindingError]()
* [PolicyViolationError]()
* [QuotaError]()
* [RangeError]()
* [RequestError]()
* [SizeLimitError]()
* [StringFormatError]()
* [StringLengthError]()
* [UrlFieldError]()
*
* @generated from protobuf rpc: MutateAds(google.ads.googleads.v11.services.MutateAdsRequest) returns (google.ads.googleads.v11.services.MutateAdsResponse);
*/
mutateAds(input: MutateAdsRequest, options?: RpcOptions): UnaryCall<MutateAdsRequest, MutateAdsResponse>;
}