google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
157 lines (156 loc) • 5.43 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";
/**
* Container for enum describing possible authentication errors.
*
* @generated from protobuf message google.ads.googleads.v11.errors.AuthenticationErrorEnum
*/
export interface AuthenticationErrorEnum {
}
/**
* Enum describing possible authentication errors.
*
* @generated from protobuf enum google.ads.googleads.v11.errors.AuthenticationErrorEnum.AuthenticationError
*/
export declare enum AuthenticationErrorEnum_AuthenticationError {
/**
* Enum unspecified.
*
* @generated from protobuf enum value: UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* The received error code is not known in this version.
*
* @generated from protobuf enum value: UNKNOWN = 1;
*/
UNKNOWN = 1,
/**
* Authentication of the request failed.
*
* @generated from protobuf enum value: AUTHENTICATION_ERROR = 2;
*/
AUTHENTICATION_ERROR = 2,
/**
* Client customer ID is not a number.
*
* @generated from protobuf enum value: CLIENT_CUSTOMER_ID_INVALID = 5;
*/
CLIENT_CUSTOMER_ID_INVALID = 5,
/**
* No customer found for the provided customer ID.
*
* @generated from protobuf enum value: CUSTOMER_NOT_FOUND = 8;
*/
CUSTOMER_NOT_FOUND = 8,
/**
* Client's Google account is deleted.
*
* @generated from protobuf enum value: GOOGLE_ACCOUNT_DELETED = 9;
*/
GOOGLE_ACCOUNT_DELETED = 9,
/**
* Google account login token in the cookie is invalid.
*
* @generated from protobuf enum value: GOOGLE_ACCOUNT_COOKIE_INVALID = 10;
*/
GOOGLE_ACCOUNT_COOKIE_INVALID = 10,
/**
* A problem occurred during Google account authentication.
*
* @generated from protobuf enum value: GOOGLE_ACCOUNT_AUTHENTICATION_FAILED = 25;
*/
GOOGLE_ACCOUNT_AUTHENTICATION_FAILED = 25,
/**
* The user in the Google account login token does not match the user ID in
* the cookie.
*
* @generated from protobuf enum value: GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH = 12;
*/
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH = 12,
/**
* Login cookie is required for authentication.
*
* @generated from protobuf enum value: LOGIN_COOKIE_REQUIRED = 13;
*/
LOGIN_COOKIE_REQUIRED = 13,
/**
* User in the cookie is not a valid Ads user.
*
* @generated from protobuf enum value: NOT_ADS_USER = 14;
*/
NOT_ADS_USER = 14,
/**
* OAuth token in the header is not valid.
*
* @generated from protobuf enum value: OAUTH_TOKEN_INVALID = 15;
*/
OAUTH_TOKEN_INVALID = 15,
/**
* OAuth token in the header has expired.
*
* @generated from protobuf enum value: OAUTH_TOKEN_EXPIRED = 16;
*/
OAUTH_TOKEN_EXPIRED = 16,
/**
* OAuth token in the header has been disabled.
*
* @generated from protobuf enum value: OAUTH_TOKEN_DISABLED = 17;
*/
OAUTH_TOKEN_DISABLED = 17,
/**
* OAuth token in the header has been revoked.
*
* @generated from protobuf enum value: OAUTH_TOKEN_REVOKED = 18;
*/
OAUTH_TOKEN_REVOKED = 18,
/**
* OAuth token HTTP header is malformed.
*
* @generated from protobuf enum value: OAUTH_TOKEN_HEADER_INVALID = 19;
*/
OAUTH_TOKEN_HEADER_INVALID = 19,
/**
* Login cookie is not valid.
*
* @generated from protobuf enum value: LOGIN_COOKIE_INVALID = 20;
*/
LOGIN_COOKIE_INVALID = 20,
/**
* User ID in the header is not a valid ID.
*
* @generated from protobuf enum value: USER_ID_INVALID = 22;
*/
USER_ID_INVALID = 22,
/**
* An account administrator changed this account's authentication settings.
* To access this Google Ads account, enable 2-Step Verification in your
* Google account at https://www.google.com/landing/2step.
*
* @generated from protobuf enum value: TWO_STEP_VERIFICATION_NOT_ENROLLED = 23;
*/
TWO_STEP_VERIFICATION_NOT_ENROLLED = 23,
/**
* An account administrator changed this account's authentication settings.
* To access this Google Ads account, enable Advanced Protection in your
* Google account at https://landing.google.com/advancedprotection.
*
* @generated from protobuf enum value: ADVANCED_PROTECTION_NOT_ENROLLED = 24;
*/
ADVANCED_PROTECTION_NOT_ENROLLED = 24
}
declare class AuthenticationErrorEnum$Type extends MessageType<AuthenticationErrorEnum> {
constructor();
create(value?: PartialMessage<AuthenticationErrorEnum>): AuthenticationErrorEnum;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AuthenticationErrorEnum): AuthenticationErrorEnum;
internalBinaryWrite(message: AuthenticationErrorEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.errors.AuthenticationErrorEnum
*/
export declare const AuthenticationErrorEnum: AuthenticationErrorEnum$Type;
export {};