google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
113 lines (112 loc) • 5.36 kB
TypeScript
import { ServiceType } from "@protobuf-ts/runtime-rpc";
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { GoogleAdsField } from "../resources/google_ads_field";
/**
* Request message for [GoogleAdsFieldService.GetGoogleAdsField][google.ads.googleads.v11.services.GoogleAdsFieldService.GetGoogleAdsField].
*
* @generated from protobuf message google.ads.googleads.v11.services.GetGoogleAdsFieldRequest
*/
export interface GetGoogleAdsFieldRequest {
/**
* Required. The resource name of the field to get.
*
* @generated from protobuf field: string resource_name = 1;
*/
resourceName: string;
}
/**
* Request message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v11.services.GoogleAdsFieldService.SearchGoogleAdsFields].
*
* @generated from protobuf message google.ads.googleads.v11.services.SearchGoogleAdsFieldsRequest
*/
export interface SearchGoogleAdsFieldsRequest {
/**
* Required. The query string.
*
* @generated from protobuf field: string query = 1;
*/
query: string;
/**
* Token of the page to retrieve. If not specified, the first page of
* results will be returned. Use the value obtained from `next_page_token`
* in the previous response in order to request the next page of results.
*
* @generated from protobuf field: string page_token = 2;
*/
pageToken: string;
/**
* Number of elements to retrieve in a single page.
* When too large a page is requested, the server may decide to further
* limit the number of returned resources.
*
* @generated from protobuf field: int32 page_size = 3;
*/
pageSize: number;
}
/**
* Response message for [GoogleAdsFieldService.SearchGoogleAdsFields][google.ads.googleads.v11.services.GoogleAdsFieldService.SearchGoogleAdsFields].
*
* @generated from protobuf message google.ads.googleads.v11.services.SearchGoogleAdsFieldsResponse
*/
export interface SearchGoogleAdsFieldsResponse {
/**
* The list of fields that matched the query.
*
* @generated from protobuf field: repeated google.ads.googleads.v11.resources.GoogleAdsField results = 1;
*/
results: GoogleAdsField[];
/**
* Pagination token used to retrieve the next page of results. Pass the
* content of this string as the `page_token` attribute of the next request.
* `next_page_token` is not returned for the last page.
*
* @generated from protobuf field: string next_page_token = 2;
*/
nextPageToken: string;
/**
* Total number of results that match the query ignoring the LIMIT clause.
*
* @generated from protobuf field: int64 total_results_count = 3;
*/
totalResultsCount: bigint;
}
declare class GetGoogleAdsFieldRequest$Type extends MessageType<GetGoogleAdsFieldRequest> {
constructor();
create(value?: PartialMessage<GetGoogleAdsFieldRequest>): GetGoogleAdsFieldRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: GetGoogleAdsFieldRequest): GetGoogleAdsFieldRequest;
internalBinaryWrite(message: GetGoogleAdsFieldRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.GetGoogleAdsFieldRequest
*/
export declare const GetGoogleAdsFieldRequest: GetGoogleAdsFieldRequest$Type;
declare class SearchGoogleAdsFieldsRequest$Type extends MessageType<SearchGoogleAdsFieldsRequest> {
constructor();
create(value?: PartialMessage<SearchGoogleAdsFieldsRequest>): SearchGoogleAdsFieldsRequest;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SearchGoogleAdsFieldsRequest): SearchGoogleAdsFieldsRequest;
internalBinaryWrite(message: SearchGoogleAdsFieldsRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.SearchGoogleAdsFieldsRequest
*/
export declare const SearchGoogleAdsFieldsRequest: SearchGoogleAdsFieldsRequest$Type;
declare class SearchGoogleAdsFieldsResponse$Type extends MessageType<SearchGoogleAdsFieldsResponse> {
constructor();
create(value?: PartialMessage<SearchGoogleAdsFieldsResponse>): SearchGoogleAdsFieldsResponse;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: SearchGoogleAdsFieldsResponse): SearchGoogleAdsFieldsResponse;
internalBinaryWrite(message: SearchGoogleAdsFieldsResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.services.SearchGoogleAdsFieldsResponse
*/
export declare const SearchGoogleAdsFieldsResponse: SearchGoogleAdsFieldsResponse$Type;
/**
* @generated ServiceType for protobuf service google.ads.googleads.v11.services.GoogleAdsFieldService
*/
export declare const GoogleAdsFieldService: ServiceType;
export {};