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
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 |
createAudienceExport(request, callback) → {undefined}
Calls CreateAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.ICreateAudienceExportRequest |
CreateAudienceExportRequest message or plain object |
callback |
google.analytics.data.v1beta.BetaAnalyticsData.CreateAudienceExportCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
Type | Description |
---|---|
undefined |
createAudienceExport(request) → {Promise.<google.longrunning.Operation>}
Calls CreateAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.ICreateAudienceExportRequest |
CreateAudienceExportRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.longrunning.Operation> |
Promise |
getAudienceExport(request, callback) → {undefined}
Calls GetAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IGetAudienceExportRequest |
GetAudienceExportRequest message or plain object |
callback |
google.analytics.data.v1beta.BetaAnalyticsData.GetAudienceExportCallback |
Node-style callback called with the error, if any, and AudienceExport |
Returns:
Type | Description |
---|---|
undefined |
getAudienceExport(request) → {Promise.<google.analytics.data.v1beta.AudienceExport>}
Calls GetAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IGetAudienceExportRequest |
GetAudienceExportRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.analytics.data.v1beta.AudienceExport> |
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 |
listAudienceExports(request, callback) → {undefined}
Calls ListAudienceExports.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IListAudienceExportsRequest |
ListAudienceExportsRequest message or plain object |
callback |
google.analytics.data.v1beta.BetaAnalyticsData.ListAudienceExportsCallback |
Node-style callback called with the error, if any, and ListAudienceExportsResponse |
Returns:
Type | Description |
---|---|
undefined |
listAudienceExports(request) → {Promise.<google.analytics.data.v1beta.ListAudienceExportsResponse>}
Calls ListAudienceExports.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IListAudienceExportsRequest |
ListAudienceExportsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.analytics.data.v1beta.ListAudienceExportsResponse> |
Promise |
queryAudienceExport(request, callback) → {undefined}
Calls QueryAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IQueryAudienceExportRequest |
QueryAudienceExportRequest message or plain object |
callback |
google.analytics.data.v1beta.BetaAnalyticsData.QueryAudienceExportCallback |
Node-style callback called with the error, if any, and QueryAudienceExportResponse |
Returns:
Type | Description |
---|---|
undefined |
queryAudienceExport(request) → {Promise.<google.analytics.data.v1beta.QueryAudienceExportResponse>}
Calls QueryAudienceExport.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.analytics.data.v1beta.IQueryAudienceExportRequest |
QueryAudienceExportRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.analytics.data.v1beta.QueryAudienceExportResponse> |
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 |
(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. |
Type Definitions
BatchRunPivotReportsCallback(error, responseopt)
Callback as used by 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 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 checkCompatibility.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.CheckCompatibilityResponse |
<optional> |
CheckCompatibilityResponse |
CreateAudienceExportCallback(error, responseopt)
Callback as used by createAudienceExport.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
GetAudienceExportCallback(error, responseopt)
Callback as used by getAudienceExport.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.AudienceExport |
<optional> |
AudienceExport |
GetMetadataCallback(error, responseopt)
Callback as used by getMetadata.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.Metadata |
<optional> |
Metadata |
ListAudienceExportsCallback(error, responseopt)
Callback as used by listAudienceExports.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.ListAudienceExportsResponse |
<optional> |
ListAudienceExportsResponse |
QueryAudienceExportCallback(error, responseopt)
Callback as used by queryAudienceExport.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.QueryAudienceExportResponse |
<optional> |
QueryAudienceExportResponse |
RunPivotReportCallback(error, responseopt)
Callback as used by 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 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 runReport.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.analytics.data.v1beta.RunReportResponse |
<optional> |
RunReportResponse |