RunFunnelReportRequest

google.analytics.data.v1alpha. RunFunnelReportRequest

Represents a RunFunnelReportRequest.

Constructor

new RunFunnelReportRequest(propertiesopt)

Constructs a new RunFunnelReportRequest.

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

Properties to set

Implements:
  • IRunFunnelReportRequest

Members

FunnelVisualizationType

FunnelVisualizationType enum.

Properties:
Name Type Description
FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED number

FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED value

STANDARD_FUNNEL number

STANDARD_FUNNEL value

TRENDED_FUNNEL number

TRENDED_FUNNEL value

dateRanges

RunFunnelReportRequest dateRanges.

dimensionFilter

RunFunnelReportRequest dimensionFilter.

funnel

RunFunnelReportRequest funnel.

funnelBreakdown

RunFunnelReportRequest funnelBreakdown.

funnelNextAction

RunFunnelReportRequest funnelNextAction.

funnelVisualizationType

RunFunnelReportRequest funnelVisualizationType.

limit

RunFunnelReportRequest limit.

property

RunFunnelReportRequest property.

returnPropertyQuota

RunFunnelReportRequest returnPropertyQuota.

segments

RunFunnelReportRequest segments.

Methods

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

Creates a new RunFunnelReportRequest instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.RunFunnelReportRequest

RunFunnelReportRequest instance

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

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

RunFunnelReportRequest

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

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

RunFunnelReportRequest

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

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

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

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

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

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

RunFunnelReportRequest

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

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

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

RunFunnelReportRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a RunFunnelReportRequest 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 RunFunnelReportRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object