Class protos.google.ads.admanager.v1.Report.DataTable.MetricValueGroup (0.1.0)

Represents a MetricValueGroup.

Package

@google-ads/admanager

Constructors

(constructor)(properties)

constructor(properties?: google.ads.admanager.v1.Report.DataTable.IMetricValueGroup);

Constructs a new MetricValueGroup.

Parameter
Name Description
properties IMetricValueGroup

Properties to set

Properties

absoluteChangeValues

public absoluteChangeValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup absoluteChangeValues.

comparisonPercentOfTotalValues

public comparisonPercentOfTotalValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup comparisonPercentOfTotalValues.

comparisonValues

public comparisonValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup comparisonValues.

flagValues

public flagValues: boolean[];

MetricValueGroup flagValues.

primaryPercentOfTotalValues

public primaryPercentOfTotalValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup primaryPercentOfTotalValues.

primaryValues

public primaryValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup primaryValues.

relativeChangeValues

public relativeChangeValues: google.ads.admanager.v1.Report.IValue[];

MetricValueGroup relativeChangeValues.

Methods

create(properties)

public static create(properties?: google.ads.admanager.v1.Report.DataTable.IMetricValueGroup): google.ads.admanager.v1.Report.DataTable.MetricValueGroup;

Creates a new MetricValueGroup instance using the specified properties.

Parameter
Name Description
properties IMetricValueGroup

Properties to set

Returns
Type Description
MetricValueGroup

MetricValueGroup instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.Report.DataTable.MetricValueGroup;

Decodes a MetricValueGroup 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
MetricValueGroup

MetricValueGroup

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.Report.DataTable.MetricValueGroup;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
MetricValueGroup

MetricValueGroup

encode(message, writer)

public static encode(message: google.ads.admanager.v1.Report.DataTable.IMetricValueGroup, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MetricValueGroup message. Does not implicitly messages.

Parameters
Name Description
message IMetricValueGroup

MetricValueGroup 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.admanager.v1.Report.DataTable.IMetricValueGroup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IMetricValueGroup

MetricValueGroup 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.admanager.v1.Report.DataTable.MetricValueGroup;

Creates a MetricValueGroup 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
MetricValueGroup

MetricValueGroup

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MetricValueGroup

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message MetricValueGroup

MetricValueGroup

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 MetricValueGroup 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