Class protos.google.analytics.admin.v1beta.Property (4.4.0)

Represents a Property.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1beta.IProperty);

Constructs a new Property.

Parameter
NameDescription
properties IProperty

Properties to set

Properties

account

public account: string;

Property account.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Property createTime.

currencyCode

public currencyCode: string;

Property currencyCode.

deleteTime

public deleteTime?: (google.protobuf.ITimestamp|null);

Property deleteTime.

displayName

public displayName: string;

Property displayName.

expireTime

public expireTime?: (google.protobuf.ITimestamp|null);

Property expireTime.

industryCategory

public industryCategory: (google.analytics.admin.v1beta.IndustryCategory|keyof typeof google.analytics.admin.v1beta.IndustryCategory);

Property industryCategory.

name

public name: string;

Property name.

parent

public parent: string;

Property parent.

propertyType

public propertyType: (google.analytics.admin.v1beta.PropertyType|keyof typeof google.analytics.admin.v1beta.PropertyType);

Property propertyType.

serviceLevel

public serviceLevel: (google.analytics.admin.v1beta.ServiceLevel|keyof typeof google.analytics.admin.v1beta.ServiceLevel);

Property serviceLevel.

timeZone

public timeZone: string;

Property timeZone.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Property updateTime.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1beta.IProperty): google.analytics.admin.v1beta.Property;

Creates a new Property instance using the specified properties.

Parameter
NameDescription
properties IProperty

Properties to set

Returns
TypeDescription
google.analytics.admin.v1beta.Property

Property instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1beta.Property;

Decodes a Property message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.analytics.admin.v1beta.Property

Property

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1beta.Property;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.analytics.admin.v1beta.Property

Property

encode(message, writer)

public static encode(message: google.analytics.admin.v1beta.IProperty, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Property message. Does not implicitly messages.

Parameters
NameDescription
message IProperty

Property message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.analytics.admin.v1beta.IProperty, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IProperty

Property message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1beta.Property;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.analytics.admin.v1beta.Property

Property

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Property

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Property to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.analytics.admin.v1beta.Property, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.analytics.admin.v1beta.Property

Property

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Property message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not