Class protos.google.analytics.data.v1beta.ResponseMetaData (4.9.0)

Represents a ResponseMetaData.

Package

@google-analytics/data

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.data.v1beta.IResponseMetaData);

Constructs a new ResponseMetaData.

Parameter
Name Description
properties IResponseMetaData

Properties to set

Properties

_currencyCode

public _currencyCode?: "currencyCode";

ResponseMetaData _currencyCode.

_emptyReason

public _emptyReason?: "emptyReason";

ResponseMetaData _emptyReason.

_schemaRestrictionResponse

public _schemaRestrictionResponse?: "schemaRestrictionResponse";

ResponseMetaData _schemaRestrictionResponse.

_subjectToThresholding

public _subjectToThresholding?: "subjectToThresholding";

ResponseMetaData _subjectToThresholding.

_timeZone

public _timeZone?: "timeZone";

ResponseMetaData _timeZone.

currencyCode

public currencyCode?: (string|null);

ResponseMetaData currencyCode.

dataLossFromOtherRow

public dataLossFromOtherRow: boolean;

ResponseMetaData dataLossFromOtherRow.

emptyReason

public emptyReason?: (string|null);

ResponseMetaData emptyReason.

samplingMetadatas

public samplingMetadatas: google.analytics.data.v1beta.ISamplingMetadata[];

ResponseMetaData samplingMetadatas.

schemaRestrictionResponse

public schemaRestrictionResponse?: (google.analytics.data.v1beta.ResponseMetaData.ISchemaRestrictionResponse|null);

ResponseMetaData schemaRestrictionResponse.

subjectToThresholding

public subjectToThresholding?: (boolean|null);

ResponseMetaData subjectToThresholding.

timeZone

public timeZone?: (string|null);

ResponseMetaData timeZone.

Methods

create(properties)

public static create(properties?: google.analytics.data.v1beta.IResponseMetaData): google.analytics.data.v1beta.ResponseMetaData;

Creates a new ResponseMetaData instance using the specified properties.

Parameter
Name Description
properties IResponseMetaData

Properties to set

Returns
Type Description
ResponseMetaData

ResponseMetaData instance

decode(reader, length)

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

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

ResponseMetaData

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ResponseMetaData

ResponseMetaData

encode(message, writer)

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

Encodes the specified ResponseMetaData message. Does not implicitly messages.

Parameters
Name Description
message IResponseMetaData

ResponseMetaData 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.v1beta.IResponseMetaData, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IResponseMetaData

ResponseMetaData 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.v1beta.ResponseMetaData;

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

ResponseMetaData

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ResponseMetaData

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ResponseMetaData

ResponseMetaData

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