google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
247 lines (246 loc) • 8.78 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";
import { UInt32Value } from "../protobuf/wrappers";
import { SourceInfo } from "./source_info";
import { SystemParameters } from "./system_parameter";
import { Monitoring } from "./monitoring";
import { Logging } from "./logging";
import { Billing } from "./billing";
import { MonitoredResourceDescriptor } from "./monitored_resource";
import { MetricDescriptor } from "./metric";
import { LogDescriptor } from "./log";
import { Control } from "./control";
import { Endpoint } from "./endpoint";
import { Usage } from "./usage";
import { Context } from "./context";
import { Authentication } from "./auth";
import { Quota } from "./quota";
import { Http } from "./http";
import { Backend } from "./backend";
import { Documentation } from "./documentation";
import { Enum } from "../protobuf/type";
import { Type } from "../protobuf/type";
import { Api } from "../protobuf/api";
/**
* `Service` is the root object of Google service configuration schema. It
* describes basic information about a service, such as the name and the
* title, and delegates other aspects to sub-sections. Each sub-section is
* either a proto message or a repeated proto message that configures a
* specific aspect, such as auth. See each proto message definition for details.
*
* Example:
*
* type: google.api.Service
* name: calendar.googleapis.com
* title: Google Calendar API
* apis:
* - name: google.calendar.v3.Calendar
* authentication:
* providers:
* - id: google_calendar_auth
* jwks_uri: https://www.googleapis.com/oauth2/v1/certs
* issuer: https://securetoken.google.com
* rules:
* - selector: "*"
* requirements:
* provider_id: google_calendar_auth
*
* @generated from protobuf message google.api.Service
*/
export interface Service {
/**
* The service name, which is a DNS-like logical identifier for the
* service, such as `calendar.googleapis.com`. The service name
* typically goes through DNS verification to make sure the owner
* of the service also owns the DNS name.
*
* @generated from protobuf field: string name = 1;
*/
name: string;
/**
* The product title for this service.
*
* @generated from protobuf field: string title = 2;
*/
title: string;
/**
* The Google project that owns this service.
*
* @generated from protobuf field: string producer_project_id = 22;
*/
producerProjectId: string;
/**
* A unique ID for a specific instance of this message, typically assigned
* by the client for tracking purpose. Must be no longer than 63 characters
* and only lower case letters, digits, '.', '_' and '-' are allowed. If
* empty, the server may choose to generate one instead.
*
* @generated from protobuf field: string id = 33;
*/
id: string;
/**
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
* author, as the remaining fields will be derived from the IDL during the
* normalization process. It is an error to specify an API interface here
* which cannot be resolved against the associated IDL files.
*
* @generated from protobuf field: repeated google.protobuf.Api apis = 3;
*/
apis: Api[];
/**
* A list of all proto message types included in this API service.
* Types referenced directly or indirectly by the `apis` are
* automatically included. Messages which are not referenced but
* shall be included, such as types used by the `google.protobuf.Any` type,
* should be listed here by name. Example:
*
* types:
* - name: google.protobuf.Int32
*
* @generated from protobuf field: repeated google.protobuf.Type types = 4;
*/
types: Type[];
/**
* A list of all enum types included in this API service. Enums
* referenced directly or indirectly by the `apis` are automatically
* included. Enums which are not referenced but shall be included
* should be listed here by name. Example:
*
* enums:
* - name: google.someapi.v1.SomeEnum
*
* @generated from protobuf field: repeated google.protobuf.Enum enums = 5;
*/
enums: Enum[];
/**
* Additional API documentation.
*
* @generated from protobuf field: google.api.Documentation documentation = 6;
*/
documentation?: Documentation;
/**
* API backend configuration.
*
* @generated from protobuf field: google.api.Backend backend = 8;
*/
backend?: Backend;
/**
* HTTP configuration.
*
* @generated from protobuf field: google.api.Http http = 9;
*/
http?: Http;
/**
* Quota configuration.
*
* @generated from protobuf field: google.api.Quota quota = 10;
*/
quota?: Quota;
/**
* Auth configuration.
*
* @generated from protobuf field: google.api.Authentication authentication = 11;
*/
authentication?: Authentication;
/**
* Context configuration.
*
* @generated from protobuf field: google.api.Context context = 12;
*/
context?: Context;
/**
* Configuration controlling usage of this service.
*
* @generated from protobuf field: google.api.Usage usage = 15;
*/
usage?: Usage;
/**
* Configuration for network endpoints. If this is empty, then an endpoint
* with the same name as the service is automatically generated to service all
* defined APIs.
*
* @generated from protobuf field: repeated google.api.Endpoint endpoints = 18;
*/
endpoints: Endpoint[];
/**
* Configuration for the service control plane.
*
* @generated from protobuf field: google.api.Control control = 21;
*/
control?: Control;
/**
* Defines the logs used by this service.
*
* @generated from protobuf field: repeated google.api.LogDescriptor logs = 23;
*/
logs: LogDescriptor[];
/**
* Defines the metrics used by this service.
*
* @generated from protobuf field: repeated google.api.MetricDescriptor metrics = 24;
*/
metrics: MetricDescriptor[];
/**
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
* @generated from protobuf field: repeated google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
monitoredResources: MonitoredResourceDescriptor[];
/**
* Billing configuration.
*
* @generated from protobuf field: google.api.Billing billing = 26;
*/
billing?: Billing;
/**
* Logging configuration.
*
* @generated from protobuf field: google.api.Logging logging = 27;
*/
logging?: Logging;
/**
* Monitoring configuration.
*
* @generated from protobuf field: google.api.Monitoring monitoring = 28;
*/
monitoring?: Monitoring;
/**
* System parameter configuration.
*
* @generated from protobuf field: google.api.SystemParameters system_parameters = 29;
*/
systemParameters?: SystemParameters;
/**
* Output only. The source information for this configuration if available.
*
* @generated from protobuf field: google.api.SourceInfo source_info = 37;
*/
sourceInfo?: SourceInfo;
/**
* Obsolete. Do not use.
*
* This field has no semantic meaning. The service config compiler always
* sets this field to `3`.
*
* @deprecated
* @generated from protobuf field: google.protobuf.UInt32Value config_version = 20 [deprecated = true];
*/
configVersion?: UInt32Value;
}
declare class Service$Type extends MessageType<Service> {
constructor();
create(value?: PartialMessage<Service>): Service;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Service): Service;
internalBinaryWrite(message: Service, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.api.Service
*/
export declare const Service: Service$Type;
export {};