ReportDefinition

google.analytics.data.v1alpha.ReportTask. ReportDefinition

Represents a ReportDefinition.

Constructor

new ReportDefinition(propertiesopt)

Constructs a new ReportDefinition.

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

Properties to set

Implements:
  • IReportDefinition

Members

cohortSpec

ReportDefinition cohortSpec.

currencyCode

ReportDefinition currencyCode.

dateRanges

ReportDefinition dateRanges.

dimensionFilter

ReportDefinition dimensionFilter.

dimensions

ReportDefinition dimensions.

keepEmptyRows

ReportDefinition keepEmptyRows.

limit

ReportDefinition limit.

metricAggregations

ReportDefinition metricAggregations.

metricFilter

ReportDefinition metricFilter.

metrics

ReportDefinition metrics.

offset

ReportDefinition offset.

orderBys

ReportDefinition orderBys.

Methods

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

Converts this ReportDefinition to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new ReportDefinition instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.ReportTask.ReportDefinition

ReportDefinition instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.ReportTask.ReportDefinition}

Decodes a ReportDefinition 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.v1alpha.ReportTask.ReportDefinition

ReportDefinition

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.ReportTask.ReportDefinition}

Decodes a ReportDefinition 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.v1alpha.ReportTask.ReportDefinition

ReportDefinition

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.IReportDefinition

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.IReportDefinition

ReportDefinition 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.v1alpha.ReportTask.ReportDefinition}

Creates a ReportDefinition 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.v1alpha.ReportTask.ReportDefinition

ReportDefinition

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ReportDefinition

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 ReportDefinition message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.ReportTask.ReportDefinition

ReportDefinition

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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