google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
80 lines (79 loc) • 3.25 kB
TypeScript
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";
/**
* `Endpoint` describes a network endpoint of a service that serves a set of
* APIs. It is commonly known as a service endpoint. A service may expose
* any number of service endpoints, and all service endpoints share the same
* service definition, such as quota limits and monitoring metrics.
*
* Example service configuration:
*
* name: library-example.googleapis.com
* endpoints:
* # Below entry makes 'google.example.library.v1.Library'
* # API be served from endpoint address library-example.googleapis.com.
* # It also allows HTTP OPTIONS calls to be passed to the backend, for
* # it to decide whether the subsequent cross-origin request is
* # allowed to proceed.
* - name: library-example.googleapis.com
* allow_cors: true
*
* @generated from protobuf message google.api.Endpoint
*/
export interface Endpoint {
/**
* The canonical name of this endpoint.
*
* @generated from protobuf field: string name = 1;
*/
name: string;
/**
* Unimplemented. Dot not use.
*
* DEPRECATED: This field is no longer supported. Instead of using aliases,
* please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intended
* aliases.
*
* Additional names that this endpoint will be hosted on.
*
* @deprecated
* @generated from protobuf field: repeated string aliases = 2 [deprecated = true];
*/
aliases: string[];
/**
* The specification of an Internet routable address of API frontend that will
* handle requests to this [API
* Endpoint](https://cloud.google.com/apis/design/glossary). It should be
* either a valid IPv4 address or a fully-qualified domain name. For example,
* "8.8.8.8" or "myservice.appspot.com".
*
* @generated from protobuf field: string target = 101;
*/
target: string;
/**
* Allowing
* [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
* cross-domain traffic, would allow the backends served from this endpoint to
* receive and respond to HTTP OPTIONS requests. The response will be used by
* the browser to determine whether the subsequent cross-origin request is
* allowed to proceed.
*
* @generated from protobuf field: bool allow_cors = 5;
*/
allowCors: boolean;
}
declare class Endpoint$Type extends MessageType<Endpoint> {
constructor();
create(value?: PartialMessage<Endpoint>): Endpoint;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Endpoint): Endpoint;
internalBinaryWrite(message: Endpoint, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.api.Endpoint
*/
export declare const Endpoint: Endpoint$Type;
export {};