RunPivotReportRequest

google.analytics.data.v1beta. RunPivotReportRequest

Represents a RunPivotReportRequest.

Constructor

new RunPivotReportRequest(propertiesopt)

Constructs a new RunPivotReportRequest.

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

Properties to set

Implements:
  • IRunPivotReportRequest

Members

cohortSpec

RunPivotReportRequest cohortSpec.

comparisons

RunPivotReportRequest comparisons.

currencyCode

RunPivotReportRequest currencyCode.

dateRanges

RunPivotReportRequest dateRanges.

dimensionFilter

RunPivotReportRequest dimensionFilter.

dimensions

RunPivotReportRequest dimensions.

keepEmptyRows

RunPivotReportRequest keepEmptyRows.

metricFilter

RunPivotReportRequest metricFilter.

metrics

RunPivotReportRequest metrics.

pivots

RunPivotReportRequest pivots.

property

RunPivotReportRequest property.

returnPropertyQuota

RunPivotReportRequest returnPropertyQuota.

Methods

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

Converts this RunPivotReportRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new RunPivotReportRequest instance using the specified properties.

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

Properties to set

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

RunPivotReportRequest instance

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

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

RunPivotReportRequest

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

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

RunPivotReportRequest

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

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

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

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

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

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

RunPivotReportRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for RunPivotReportRequest

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

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

RunPivotReportRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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