@google-ads/admanager
Version:
Google Ad Manager API client for Node.js
981 lines (798 loc) • 1.2 MB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace ads. */
namespace ads {
/** Namespace admanager. */
namespace admanager {
/** Namespace v1. */
namespace v1 {
/** Properties of an AdUnitStatusEnum. */
interface IAdUnitStatusEnum {
}
/** Represents an AdUnitStatusEnum. */
class AdUnitStatusEnum implements IAdUnitStatusEnum {
/**
* Constructs a new AdUnitStatusEnum.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.IAdUnitStatusEnum);
/**
* Creates a new AdUnitStatusEnum instance using the specified properties.
* @param [properties] Properties to set
* @returns AdUnitStatusEnum instance
*/
public static create(properties?: google.ads.admanager.v1.IAdUnitStatusEnum): google.ads.admanager.v1.AdUnitStatusEnum;
/**
* Encodes the specified AdUnitStatusEnum message. Does not implicitly {@link google.ads.admanager.v1.AdUnitStatusEnum.verify|verify} messages.
* @param message AdUnitStatusEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.IAdUnitStatusEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AdUnitStatusEnum message, length delimited. Does not implicitly {@link google.ads.admanager.v1.AdUnitStatusEnum.verify|verify} messages.
* @param message AdUnitStatusEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.IAdUnitStatusEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AdUnitStatusEnum message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AdUnitStatusEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdUnitStatusEnum;
/**
* Decodes an AdUnitStatusEnum message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AdUnitStatusEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdUnitStatusEnum;
/**
* Verifies an AdUnitStatusEnum message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AdUnitStatusEnum message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AdUnitStatusEnum
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.AdUnitStatusEnum;
/**
* Creates a plain object from an AdUnitStatusEnum message. Also converts values to other types if specified.
* @param message AdUnitStatusEnum
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.AdUnitStatusEnum, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AdUnitStatusEnum to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AdUnitStatusEnum
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace AdUnitStatusEnum {
/** AdUnitStatus enum. */
enum AdUnitStatus {
AD_UNIT_STATUS_UNSPECIFIED = 0,
ACTIVE = 1,
INACTIVE = 2,
ARCHIVED = 3
}
}
/** Properties of a SmartSizeModeEnum. */
interface ISmartSizeModeEnum {
}
/** Represents a SmartSizeModeEnum. */
class SmartSizeModeEnum implements ISmartSizeModeEnum {
/**
* Constructs a new SmartSizeModeEnum.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.ISmartSizeModeEnum);
/**
* Creates a new SmartSizeModeEnum instance using the specified properties.
* @param [properties] Properties to set
* @returns SmartSizeModeEnum instance
*/
public static create(properties?: google.ads.admanager.v1.ISmartSizeModeEnum): google.ads.admanager.v1.SmartSizeModeEnum;
/**
* Encodes the specified SmartSizeModeEnum message. Does not implicitly {@link google.ads.admanager.v1.SmartSizeModeEnum.verify|verify} messages.
* @param message SmartSizeModeEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.ISmartSizeModeEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SmartSizeModeEnum message, length delimited. Does not implicitly {@link google.ads.admanager.v1.SmartSizeModeEnum.verify|verify} messages.
* @param message SmartSizeModeEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.ISmartSizeModeEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SmartSizeModeEnum message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SmartSizeModeEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.SmartSizeModeEnum;
/**
* Decodes a SmartSizeModeEnum message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SmartSizeModeEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.SmartSizeModeEnum;
/**
* Verifies a SmartSizeModeEnum message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SmartSizeModeEnum message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SmartSizeModeEnum
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.SmartSizeModeEnum;
/**
* Creates a plain object from a SmartSizeModeEnum message. Also converts values to other types if specified.
* @param message SmartSizeModeEnum
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.SmartSizeModeEnum, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SmartSizeModeEnum to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SmartSizeModeEnum
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace SmartSizeModeEnum {
/** SmartSizeMode enum. */
enum SmartSizeMode {
SMART_SIZE_MODE_UNSPECIFIED = 0,
NONE = 1,
SMART_BANNER = 2,
DYNAMIC_SIZE = 3
}
}
/** Properties of a TargetWindowEnum. */
interface ITargetWindowEnum {
}
/** Represents a TargetWindowEnum. */
class TargetWindowEnum implements ITargetWindowEnum {
/**
* Constructs a new TargetWindowEnum.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.ITargetWindowEnum);
/**
* Creates a new TargetWindowEnum instance using the specified properties.
* @param [properties] Properties to set
* @returns TargetWindowEnum instance
*/
public static create(properties?: google.ads.admanager.v1.ITargetWindowEnum): google.ads.admanager.v1.TargetWindowEnum;
/**
* Encodes the specified TargetWindowEnum message. Does not implicitly {@link google.ads.admanager.v1.TargetWindowEnum.verify|verify} messages.
* @param message TargetWindowEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.ITargetWindowEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified TargetWindowEnum message, length delimited. Does not implicitly {@link google.ads.admanager.v1.TargetWindowEnum.verify|verify} messages.
* @param message TargetWindowEnum message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.ITargetWindowEnum, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a TargetWindowEnum message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns TargetWindowEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.TargetWindowEnum;
/**
* Decodes a TargetWindowEnum message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns TargetWindowEnum
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.TargetWindowEnum;
/**
* Verifies a TargetWindowEnum message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a TargetWindowEnum message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns TargetWindowEnum
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.TargetWindowEnum;
/**
* Creates a plain object from a TargetWindowEnum message. Also converts values to other types if specified.
* @param message TargetWindowEnum
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.TargetWindowEnum, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this TargetWindowEnum to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for TargetWindowEnum
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace TargetWindowEnum {
/** TargetWindow enum. */
enum TargetWindow {
TARGET_WINDOW_UNSPECIFIED = 0,
TOP = 1,
BLANK = 2
}
}
/** Properties of an AdUnit. */
interface IAdUnit {
/** AdUnit name */
name?: (string|null);
/** AdUnit adUnitId */
adUnitId?: (number|Long|string|null);
/** AdUnit parentAdUnit */
parentAdUnit?: (string|null);
/** AdUnit parentPath */
parentPath?: (google.ads.admanager.v1.IAdUnitParent[]|null);
/** AdUnit displayName */
displayName?: (string|null);
/** AdUnit adUnitCode */
adUnitCode?: (string|null);
/** AdUnit status */
status?: (google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus|keyof typeof google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus|null);
/** AdUnit appliedTargetWindow */
appliedTargetWindow?: (google.ads.admanager.v1.TargetWindowEnum.TargetWindow|keyof typeof google.ads.admanager.v1.TargetWindowEnum.TargetWindow|null);
/** AdUnit effectiveTargetWindow */
effectiveTargetWindow?: (google.ads.admanager.v1.TargetWindowEnum.TargetWindow|keyof typeof google.ads.admanager.v1.TargetWindowEnum.TargetWindow|null);
/** AdUnit appliedTeams */
appliedTeams?: (string[]|null);
/** AdUnit teams */
teams?: (string[]|null);
/** AdUnit description */
description?: (string|null);
/** AdUnit explicitlyTargeted */
explicitlyTargeted?: (boolean|null);
/** AdUnit hasChildren */
hasChildren?: (boolean|null);
/** AdUnit updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** AdUnit adUnitSizes */
adUnitSizes?: (google.ads.admanager.v1.IAdUnitSize[]|null);
/** AdUnit externalSetTopBoxChannelId */
externalSetTopBoxChannelId?: (string|null);
/** AdUnit refreshDelay */
refreshDelay?: (google.protobuf.IDuration|null);
/** AdUnit appliedLabels */
appliedLabels?: (google.ads.admanager.v1.IAppliedLabel[]|null);
/** AdUnit effectiveAppliedLabels */
effectiveAppliedLabels?: (google.ads.admanager.v1.IAppliedLabel[]|null);
/** AdUnit appliedLabelFrequencyCaps */
appliedLabelFrequencyCaps?: (google.ads.admanager.v1.ILabelFrequencyCap[]|null);
/** AdUnit effectiveLabelFrequencyCaps */
effectiveLabelFrequencyCaps?: (google.ads.admanager.v1.ILabelFrequencyCap[]|null);
/** AdUnit smartSizeMode */
smartSizeMode?: (google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode|keyof typeof google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode|null);
/** AdUnit appliedAdsenseEnabled */
appliedAdsenseEnabled?: (boolean|null);
/** AdUnit effectiveAdsenseEnabled */
effectiveAdsenseEnabled?: (boolean|null);
}
/** Represents an AdUnit. */
class AdUnit implements IAdUnit {
/**
* Constructs a new AdUnit.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.IAdUnit);
/** AdUnit name. */
public name: string;
/** AdUnit adUnitId. */
public adUnitId: (number|Long|string);
/** AdUnit parentAdUnit. */
public parentAdUnit: string;
/** AdUnit parentPath. */
public parentPath: google.ads.admanager.v1.IAdUnitParent[];
/** AdUnit displayName. */
public displayName: string;
/** AdUnit adUnitCode. */
public adUnitCode: string;
/** AdUnit status. */
public status: (google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus|keyof typeof google.ads.admanager.v1.AdUnitStatusEnum.AdUnitStatus);
/** AdUnit appliedTargetWindow. */
public appliedTargetWindow: (google.ads.admanager.v1.TargetWindowEnum.TargetWindow|keyof typeof google.ads.admanager.v1.TargetWindowEnum.TargetWindow);
/** AdUnit effectiveTargetWindow. */
public effectiveTargetWindow: (google.ads.admanager.v1.TargetWindowEnum.TargetWindow|keyof typeof google.ads.admanager.v1.TargetWindowEnum.TargetWindow);
/** AdUnit appliedTeams. */
public appliedTeams: string[];
/** AdUnit teams. */
public teams: string[];
/** AdUnit description. */
public description: string;
/** AdUnit explicitlyTargeted. */
public explicitlyTargeted: boolean;
/** AdUnit hasChildren. */
public hasChildren: boolean;
/** AdUnit updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** AdUnit adUnitSizes. */
public adUnitSizes: google.ads.admanager.v1.IAdUnitSize[];
/** AdUnit externalSetTopBoxChannelId. */
public externalSetTopBoxChannelId: string;
/** AdUnit refreshDelay. */
public refreshDelay?: (google.protobuf.IDuration|null);
/** AdUnit appliedLabels. */
public appliedLabels: google.ads.admanager.v1.IAppliedLabel[];
/** AdUnit effectiveAppliedLabels. */
public effectiveAppliedLabels: google.ads.admanager.v1.IAppliedLabel[];
/** AdUnit appliedLabelFrequencyCaps. */
public appliedLabelFrequencyCaps: google.ads.admanager.v1.ILabelFrequencyCap[];
/** AdUnit effectiveLabelFrequencyCaps. */
public effectiveLabelFrequencyCaps: google.ads.admanager.v1.ILabelFrequencyCap[];
/** AdUnit smartSizeMode. */
public smartSizeMode: (google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode|keyof typeof google.ads.admanager.v1.SmartSizeModeEnum.SmartSizeMode);
/** AdUnit appliedAdsenseEnabled. */
public appliedAdsenseEnabled?: (boolean|null);
/** AdUnit effectiveAdsenseEnabled. */
public effectiveAdsenseEnabled: boolean;
/** AdUnit _appliedAdsenseEnabled. */
public _appliedAdsenseEnabled?: "appliedAdsenseEnabled";
/**
* Creates a new AdUnit instance using the specified properties.
* @param [properties] Properties to set
* @returns AdUnit instance
*/
public static create(properties?: google.ads.admanager.v1.IAdUnit): google.ads.admanager.v1.AdUnit;
/**
* Encodes the specified AdUnit message. Does not implicitly {@link google.ads.admanager.v1.AdUnit.verify|verify} messages.
* @param message AdUnit message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.IAdUnit, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AdUnit message, length delimited. Does not implicitly {@link google.ads.admanager.v1.AdUnit.verify|verify} messages.
* @param message AdUnit message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.IAdUnit, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AdUnit message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AdUnit
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdUnit;
/**
* Decodes an AdUnit message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AdUnit
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdUnit;
/**
* Verifies an AdUnit message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AdUnit message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AdUnit
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.AdUnit;
/**
* Creates a plain object from an AdUnit message. Also converts values to other types if specified.
* @param message AdUnit
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.AdUnit, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AdUnit to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AdUnit
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an AdUnitSize. */
interface IAdUnitSize {
/** AdUnitSize size */
size?: (google.ads.admanager.v1.ISize|null);
/** AdUnitSize environmentType */
environmentType?: (google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType|keyof typeof google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType|null);
/** AdUnitSize companions */
companions?: (google.ads.admanager.v1.ISize[]|null);
}
/** Represents an AdUnitSize. */
class AdUnitSize implements IAdUnitSize {
/**
* Constructs a new AdUnitSize.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.IAdUnitSize);
/** AdUnitSize size. */
public size?: (google.ads.admanager.v1.ISize|null);
/** AdUnitSize environmentType. */
public environmentType: (google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType|keyof typeof google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType);
/** AdUnitSize companions. */
public companions: google.ads.admanager.v1.ISize[];
/**
* Creates a new AdUnitSize instance using the specified properties.
* @param [properties] Properties to set
* @returns AdUnitSize instance
*/
public static create(properties?: google.ads.admanager.v1.IAdUnitSize): google.ads.admanager.v1.AdUnitSize;
/**
* Encodes the specified AdUnitSize message. Does not implicitly {@link google.ads.admanager.v1.AdUnitSize.verify|verify} messages.
* @param message AdUnitSize message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.IAdUnitSize, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AdUnitSize message, length delimited. Does not implicitly {@link google.ads.admanager.v1.AdUnitSize.verify|verify} messages.
* @param message AdUnitSize message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.IAdUnitSize, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AdUnitSize message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AdUnitSize
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdUnitSize;
/**
* Decodes an AdUnitSize message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AdUnitSize
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdUnitSize;
/**
* Verifies an AdUnitSize message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AdUnitSize message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AdUnitSize
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.AdUnitSize;
/**
* Creates a plain object from an AdUnitSize message. Also converts values to other types if specified.
* @param message AdUnitSize
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.AdUnitSize, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AdUnitSize to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AdUnitSize
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an AdUnitParent. */
interface IAdUnitParent {
/** AdUnitParent parentAdUnit */
parentAdUnit?: (string|null);
/** AdUnitParent displayName */
displayName?: (string|null);
/** AdUnitParent adUnitCode */
adUnitCode?: (string|null);
}
/** Represents an AdUnitParent. */
class AdUnitParent implements IAdUnitParent {
/**
* Constructs a new AdUnitParent.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.IAdUnitParent);
/** AdUnitParent parentAdUnit. */
public parentAdUnit: string;
/** AdUnitParent displayName. */
public displayName: string;
/** AdUnitParent adUnitCode. */
public adUnitCode: string;
/**
* Creates a new AdUnitParent instance using the specified properties.
* @param [properties] Properties to set
* @returns AdUnitParent instance
*/
public static create(properties?: google.ads.admanager.v1.IAdUnitParent): google.ads.admanager.v1.AdUnitParent;
/**
* Encodes the specified AdUnitParent message. Does not implicitly {@link google.ads.admanager.v1.AdUnitParent.verify|verify} messages.
* @param message AdUnitParent message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.IAdUnitParent, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AdUnitParent message, length delimited. Does not implicitly {@link google.ads.admanager.v1.AdUnitParent.verify|verify} messages.
* @param message AdUnitParent message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.IAdUnitParent, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AdUnitParent message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AdUnitParent
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdUnitParent;
/**
* Decodes an AdUnitParent message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AdUnitParent
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdUnitParent;
/**
* Verifies an AdUnitParent message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AdUnitParent message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AdUnitParent
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.AdUnitParent;
/**
* Creates a plain object from an AdUnitParent message. Also converts values to other types if specified.
* @param message AdUnitParent
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.AdUnitParent, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AdUnitParent to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AdUnitParent
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a LabelFrequencyCap. */
interface ILabelFrequencyCap {
/** LabelFrequencyCap label */
label?: (string|null);
/** LabelFrequencyCap frequencyCap */
frequencyCap?: (google.ads.admanager.v1.IFrequencyCap|null);
}
/** Represents a LabelFrequencyCap. */
class LabelFrequencyCap implements ILabelFrequencyCap {
/**
* Constructs a new LabelFrequencyCap.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.ILabelFrequencyCap);
/** LabelFrequencyCap label. */
public label: string;
/** LabelFrequencyCap frequencyCap. */
public frequencyCap?: (google.ads.admanager.v1.IFrequencyCap|null);
/**
* Creates a new LabelFrequencyCap instance using the specified properties.
* @param [properties] Properties to set
* @returns LabelFrequencyCap instance
*/
public static create(properties?: google.ads.admanager.v1.ILabelFrequencyCap): google.ads.admanager.v1.LabelFrequencyCap;
/**
* Encodes the specified LabelFrequencyCap message. Does not implicitly {@link google.ads.admanager.v1.LabelFrequencyCap.verify|verify} messages.
* @param message LabelFrequencyCap message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.ILabelFrequencyCap, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified LabelFrequencyCap message, length delimited. Does not implicitly {@link google.ads.admanager.v1.LabelFrequencyCap.verify|verify} messages.
* @param message LabelFrequencyCap message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.ILabelFrequencyCap, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a LabelFrequencyCap message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns LabelFrequencyCap
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.LabelFrequencyCap;
/**
* Decodes a LabelFrequencyCap message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns LabelFrequencyCap
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.LabelFrequencyCap;
/**
* Verifies a LabelFrequencyCap message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a LabelFrequencyCap message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns LabelFrequencyCap
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.LabelFrequencyCap;
/**
* Creates a plain object from a LabelFrequencyCap message. Also converts values to other types if specified.
* @param message LabelFrequencyCap
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.admanager.v1.LabelFrequencyCap, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this LabelFrequencyCap to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for LabelFrequencyCap
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an AppliedLabel. */
interface IAppliedLabel {
/** AppliedLabel label */
label?: (string|null);
/** AppliedLabel negated */
negated?: (boolean|null);
}
/** Represents an AppliedLabel. */
class AppliedLabel implements IAppliedLabel {
/**
* Constructs a new AppliedLabel.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.admanager.v1.IAppliedLabel);
/** AppliedLabel label. */
public label: string;
/** AppliedLabel negated. */
public negated: boolean;
/**
* Creates a new AppliedLabel instance using the specified properties.
* @param [properties] Properties to set
* @returns AppliedLabel instance
*/
public static create(properties?: google.ads.admanager.v1.IAppliedLabel): google.ads.admanager.v1.AppliedLabel;
/**
* Encodes the specified AppliedLabel message. Does not implicitly {@link google.ads.admanager.v1.AppliedLabel.verify|verify} messages.
* @param message AppliedLabel message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.admanager.v1.IAppliedLabel, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AppliedLabel message, length delimited. Does not implicitly {@link google.ads.admanager.v1.AppliedLabel.verify|verify} messages.
* @param message AppliedLabel message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.admanager.v1.IAppliedLabel, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AppliedLabel message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AppliedLabel
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AppliedLabel;
/**
* Decodes an AppliedLabel message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AppliedLabel
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AppliedLabel;
/**
* Verifies an AppliedLabel message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AppliedLabel message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AppliedLabel
*/
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.AppliedLabel;
/**
* Creates a plain obj