BetaAnalyticsData

google.analytics.data.v1beta. BetaAnalyticsData

Represents a BetaAnalyticsData

Constructor

new BetaAnalyticsData(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new BetaAnalyticsData service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {BetaAnalyticsData}

Creates new BetaAnalyticsData service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
BetaAnalyticsData

RPC service. Useful where requests and/or responses are streamed.

batchRunPivotReports(request, callback) → {undefined}

Calls BatchRunPivotReports.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IBatchRunPivotReportsRequest

BatchRunPivotReportsRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReportsCallback

Node-style callback called with the error, if any, and BatchRunPivotReportsResponse

Returns:
Type Description
undefined

batchRunPivotReports(request) → {Promise.<google.analytics.data.v1beta.BatchRunPivotReportsResponse>}

Calls BatchRunPivotReports.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IBatchRunPivotReportsRequest

BatchRunPivotReportsRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.BatchRunPivotReportsResponse>

Promise

batchRunReports(request, callback) → {undefined}

Calls BatchRunReports.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IBatchRunReportsRequest

BatchRunReportsRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReportsCallback

Node-style callback called with the error, if any, and BatchRunReportsResponse

Returns:
Type Description
undefined

batchRunReports(request) → {Promise.<google.analytics.data.v1beta.BatchRunReportsResponse>}

Calls BatchRunReports.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IBatchRunReportsRequest

BatchRunReportsRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.BatchRunReportsResponse>

Promise

checkCompatibility(request, callback) → {undefined}

Calls CheckCompatibility.

Parameters:
Name Type Description
request google.analytics.data.v1beta.ICheckCompatibilityRequest

CheckCompatibilityRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibilityCallback

Node-style callback called with the error, if any, and CheckCompatibilityResponse

Returns:
Type Description
undefined

checkCompatibility(request) → {Promise.<google.analytics.data.v1beta.CheckCompatibilityResponse>}

Calls CheckCompatibility.

Parameters:
Name Type Description
request google.analytics.data.v1beta.ICheckCompatibilityRequest

CheckCompatibilityRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.CheckCompatibilityResponse>

Promise

getMetadata(request, callback) → {undefined}

Calls GetMetadata.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IGetMetadataRequest

GetMetadataRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.GetMetadataCallback

Node-style callback called with the error, if any, and Metadata

Returns:
Type Description
undefined

getMetadata(request) → {Promise.<google.analytics.data.v1beta.Metadata>}

Calls GetMetadata.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IGetMetadataRequest

GetMetadataRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.Metadata>

Promise

runPivotReport(request, callback) → {undefined}

Calls RunPivotReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunPivotReportRequest

RunPivotReportRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReportCallback

Node-style callback called with the error, if any, and RunPivotReportResponse

Returns:
Type Description
undefined

runPivotReport(request) → {Promise.<google.analytics.data.v1beta.RunPivotReportResponse>}

Calls RunPivotReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunPivotReportRequest

RunPivotReportRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.RunPivotReportResponse>

Promise

runRealtimeReport(request, callback) → {undefined}

Calls RunRealtimeReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReportCallback

Node-style callback called with the error, if any, and RunRealtimeReportResponse

Returns:
Type Description
undefined

runRealtimeReport(request) → {Promise.<google.analytics.data.v1beta.RunRealtimeReportResponse>}

Calls RunRealtimeReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.RunRealtimeReportResponse>

Promise

runReport(request, callback) → {undefined}

Calls RunReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunReportRequest

RunReportRequest message or plain object

callback google.analytics.data.v1beta.BetaAnalyticsData.RunReportCallback

Node-style callback called with the error, if any, and RunReportResponse

Returns:
Type Description
undefined

runReport(request) → {Promise.<google.analytics.data.v1beta.RunReportResponse>}

Calls RunReport.

Parameters:
Name Type Description
request google.analytics.data.v1beta.IRunReportRequest

RunReportRequest message or plain object

Returns:
Type Description
Promise.<google.analytics.data.v1beta.RunReportResponse>

Promise

Type Definitions

BatchRunPivotReportsCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#batchRunPivotReports.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.BatchRunPivotReportsResponse <optional>

BatchRunPivotReportsResponse

BatchRunReportsCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#batchRunReports.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.BatchRunReportsResponse <optional>

BatchRunReportsResponse

CheckCompatibilityCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#checkCompatibility.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.CheckCompatibilityResponse <optional>

CheckCompatibilityResponse

GetMetadataCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#getMetadata.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.Metadata <optional>

Metadata

RunPivotReportCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#runPivotReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.RunPivotReportResponse <optional>

RunPivotReportResponse

RunRealtimeReportCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#runRealtimeReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.RunRealtimeReportResponse <optional>

RunRealtimeReportResponse

RunReportCallback(error, responseopt)

Callback as used by google.analytics.data.v1beta.BetaAnalyticsData#runReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.analytics.data.v1beta.RunReportResponse <optional>

RunReportResponse