RunRealtimeReportRequest

google.analytics.data.v1beta. RunRealtimeReportRequest

Represents a RunRealtimeReportRequest.

Constructor

new RunRealtimeReportRequest(propertiesopt)

Constructs a new RunRealtimeReportRequest.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1beta.IRunRealtimeReportRequest <optional>

Properties to set

Implements:
  • IRunRealtimeReportRequest

Members

dimensionFilter

RunRealtimeReportRequest dimensionFilter.

dimensions

RunRealtimeReportRequest dimensions.

limit

RunRealtimeReportRequest limit.

metricAggregations

RunRealtimeReportRequest metricAggregations.

metricFilter

RunRealtimeReportRequest metricFilter.

metrics

RunRealtimeReportRequest metrics.

minuteRanges

RunRealtimeReportRequest minuteRanges.

orderBys

RunRealtimeReportRequest orderBys.

property

RunRealtimeReportRequest property.

returnPropertyQuota

RunRealtimeReportRequest returnPropertyQuota.

Methods

(static) create(propertiesopt) → {google.analytics.data.v1beta.RunRealtimeReportRequest}

Creates a new RunRealtimeReportRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1beta.IRunRealtimeReportRequest <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1beta.RunRealtimeReportRequest}

Decodes a RunRealtimeReportRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.data.v1beta.RunRealtimeReportRequest}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified RunRealtimeReportRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.data.v1beta.RunRealtimeReportRequest}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1beta.RunRealtimeReportRequest

RunRealtimeReportRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a RunRealtimeReportRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this RunRealtimeReportRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object