RunReportRequest

google.analytics.data.v1beta. RunReportRequest

Represents a RunReportRequest.

Constructor

new RunReportRequest(propertiesopt)

Constructs a new RunReportRequest.

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

Properties to set

Implements:
  • IRunReportRequest

Members

cohortSpec

RunReportRequest cohortSpec.

currencyCode

RunReportRequest currencyCode.

dateRanges

RunReportRequest dateRanges.

dimensionFilter

RunReportRequest dimensionFilter.

dimensions

RunReportRequest dimensions.

keepEmptyRows

RunReportRequest keepEmptyRows.

limit

RunReportRequest limit.

metricAggregations

RunReportRequest metricAggregations.

metricFilter

RunReportRequest metricFilter.

metrics

RunReportRequest metrics.

offset

RunReportRequest offset.

orderBys

RunReportRequest orderBys.

property

RunReportRequest property.

returnPropertyQuota

RunReportRequest returnPropertyQuota.

Methods

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

Converts this RunReportRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new RunReportRequest instance using the specified properties.

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

Properties to set

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

RunReportRequest instance

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

Decodes a RunReportRequest 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.RunReportRequest

RunReportRequest

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.RunReportRequest}

Decodes a RunReportRequest 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.RunReportRequest

RunReportRequest

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 RunReportRequest message. Does not implicitly verify messages.

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

RunReportRequest 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 RunReportRequest message, length delimited. Does not implicitly verify messages.

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

RunReportRequest 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.RunReportRequest}

Creates a RunReportRequest 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.RunReportRequest

RunReportRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for RunReportRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

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

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

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

RunReportRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a RunReportRequest 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