Class protos.google.analytics.data.v1alpha.AudienceDimensionValue (4.5.0)

Represents an AudienceDimensionValue.

Package

@google-analytics/data

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.data.v1alpha.IAudienceDimensionValue);

Constructs a new AudienceDimensionValue.

Parameter
Name Description
properties IAudienceDimensionValue

Properties to set

Properties

oneValue

public oneValue?: "value";

AudienceDimensionValue oneValue.

value

public value?: (string|null);

AudienceDimensionValue value.

Methods

create(properties)

public static create(properties?: google.analytics.data.v1alpha.IAudienceDimensionValue): google.analytics.data.v1alpha.AudienceDimensionValue;

Creates a new AudienceDimensionValue instance using the specified properties.

Parameter
Name Description
properties IAudienceDimensionValue

Properties to set

Returns
Type Description
AudienceDimensionValue

AudienceDimensionValue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.AudienceDimensionValue;

Decodes an AudienceDimensionValue 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
AudienceDimensionValue

AudienceDimensionValue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.AudienceDimensionValue;

Decodes an AudienceDimensionValue message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AudienceDimensionValue

AudienceDimensionValue

encode(message, writer)

public static encode(message: google.analytics.data.v1alpha.IAudienceDimensionValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AudienceDimensionValue message. Does not implicitly messages.

Parameters
Name Description
message IAudienceDimensionValue

AudienceDimensionValue 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.analytics.data.v1alpha.IAudienceDimensionValue, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAudienceDimensionValue

AudienceDimensionValue 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.analytics.data.v1alpha.AudienceDimensionValue;

Creates an AudienceDimensionValue 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
AudienceDimensionValue

AudienceDimensionValue

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AudienceDimensionValue

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 AudienceDimensionValue to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AudienceDimensionValue

AudienceDimensionValue

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 an AudienceDimensionValue 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