Class protos.google.ads.datamanager.v1.UserListGlobalLicense (1.0.0)

Represents a UserListGlobalLicense.

Implements

Package

@google-ads/datamanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.datamanager.v1.IUserListGlobalLicense);

Constructs a new UserListGlobalLicense.

Parameter
Name Description
properties IUserListGlobalLicense

Properties to set

Properties

historicalPricings

public historicalPricings: google.ads.datamanager.v1.IUserListLicensePricing[];

UserListGlobalLicense historicalPricings.

licenseType

public licenseType?: (google.ads.datamanager.v1.UserListGlobalLicenseType|keyof typeof google.ads.datamanager.v1.UserListGlobalLicenseType|null);

UserListGlobalLicense licenseType.

metrics

public metrics?: (google.ads.datamanager.v1.IUserListLicenseMetrics|null);

UserListGlobalLicense metrics.

name

public name: string;

UserListGlobalLicense name.

pricing

public pricing?: (google.ads.datamanager.v1.IUserListLicensePricing|null);

UserListGlobalLicense pricing.

status

public status?: (google.ads.datamanager.v1.UserListLicenseStatus|keyof typeof google.ads.datamanager.v1.UserListLicenseStatus|null);

UserListGlobalLicense status.

userListDisplayName

public userListDisplayName: string;

UserListGlobalLicense userListDisplayName.

userListId

public userListId?: (number|Long|string|null);

UserListGlobalLicense userListId.

Methods

create(properties)

public static create(properties?: google.ads.datamanager.v1.IUserListGlobalLicense): google.ads.datamanager.v1.UserListGlobalLicense;

Creates a new UserListGlobalLicense instance using the specified properties.

Parameter
Name Description
properties IUserListGlobalLicense

Properties to set

Returns
Type Description
UserListGlobalLicense

UserListGlobalLicense instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.datamanager.v1.UserListGlobalLicense;

Decodes a UserListGlobalLicense message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
UserListGlobalLicense

UserListGlobalLicense

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.datamanager.v1.UserListGlobalLicense;

Decodes a UserListGlobalLicense message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UserListGlobalLicense

UserListGlobalLicense

encode(message, writer)

public static encode(message: google.ads.datamanager.v1.IUserListGlobalLicense, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UserListGlobalLicense message. Does not implicitly messages.

Parameters
Name Description
message IUserListGlobalLicense

UserListGlobalLicense message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.ads.datamanager.v1.IUserListGlobalLicense, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UserListGlobalLicense message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IUserListGlobalLicense

UserListGlobalLicense message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.ads.datamanager.v1.UserListGlobalLicense;

Creates a UserListGlobalLicense message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
UserListGlobalLicense

UserListGlobalLicense

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for UserListGlobalLicense

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this UserListGlobalLicense to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.ads.datamanager.v1.UserListGlobalLicense, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a UserListGlobalLicense message. Also converts values to other types if specified.

Parameters
Name Description
message UserListGlobalLicense

UserListGlobalLicense

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a UserListGlobalLicense message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not