RunReportRequest

google.analytics.data.v1alpha. RunReportRequest

Represents a RunReportRequest.

Constructor

new RunReportRequest(propertiesopt)

Constructs a new RunReportRequest.

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

Properties to set
Implements:
  • IRunReportRequest

Members

cohortSpec :google.analytics.data.v1alpha.ICohortSpec|null|undefined

RunReportRequest cohortSpec.

currencyCode :string

RunReportRequest currencyCode.

dateRanges :Array.<google.analytics.data.v1alpha.IDateRange>

RunReportRequest dateRanges.

dimensionFilter :google.analytics.data.v1alpha.IFilterExpression|null|undefined

RunReportRequest dimensionFilter.

dimensions :Array.<google.analytics.data.v1alpha.IDimension>

RunReportRequest dimensions.

entity :google.analytics.data.v1alpha.IEntity|null|undefined

RunReportRequest entity.

keepEmptyRows :boolean

RunReportRequest keepEmptyRows.

limit :number|Long

RunReportRequest limit.

metricAggregations :Array.<google.analytics.data.v1alpha.MetricAggregation>

RunReportRequest metricAggregations.

metricFilter :google.analytics.data.v1alpha.IFilterExpression|null|undefined

RunReportRequest metricFilter.

metrics :Array.<google.analytics.data.v1alpha.IMetric>

RunReportRequest metrics.

offset :number|Long

RunReportRequest offset.

orderBys :Array.<google.analytics.data.v1alpha.IOrderBy>

RunReportRequest orderBys.

returnPropertyQuota :boolean

RunReportRequest returnPropertyQuota.

Methods

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

Creates a new RunReportRequest instance using the specified properties.

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

Properties to set

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.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
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.v1alpha.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
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.v1alpha.IRunReportRequest

RunReportRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(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.v1alpha.IRunReportRequest

RunReportRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.analytics.data.v1alpha.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

(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.v1alpha.RunReportRequest

RunReportRequest
options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a RunReportRequest message.

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

Plain object to verify

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

Converts this RunReportRequest to JSON.