Class v1beta.BetaAnalyticsDataClient (3.2.1)

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. 
 *  Specified in the URL path and not the body. To learn more, see where to 
 *  find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  This property must be specified for the batch. The property within 
 *  RunPivotReportRequest may either be unspecified or consistent with this 
 *  property. 
 *  Example: properties/1234 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  Individual requests. Each request has a separate pivot report response. 
 *  Each batch request is allowed up to 5 requests. 
 */ 
  
 // const requests = 1234 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callBatchRunPivotReports 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 batchRunPivotReports 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callBatchRunPivotReports 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. 
 *  Specified in the URL path and not the body. To learn more, see where to 
 *  find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  This property must be specified for the batch. The property within 
 *  RunReportRequest may either be unspecified or consistent with this 
 *  property. 
 *  Example: properties/1234 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  Individual requests. Each request has a separate report response. Each 
 *  batch request is allowed up to 5 requests. 
 */ 
  
 // const requests = 1234 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callBatchRunReports 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 batchRunReports 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callBatchRunReports 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. To 
 *  learn more, see where to find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  `property` should be the same value as in your `runReport` request. 
 *  Example: properties/1234 
 *  Set the Property ID to 0 for compatibility checking on dimensions and 
 *  metrics common to all properties. In this special mode, this method will 
 *  not return custom dimensions and metrics. 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  The dimensions in this report. `dimensions` should be the same value as in 
 *  your `runReport` request. 
 */ 
  
 // const dimensions = 1234 
  
 /** 
 *  The metrics in this report. `metrics` should be the same value as in your 
 *  `runReport` request. 
 */ 
  
 // const metrics = 1234 
  
 /** 
 *  The filter clause of dimensions. `dimensionFilter` should be the same value 
 *  as in your `runReport` request. 
 */ 
  
 // const dimensionFilter = {} 
  
 /** 
 *  The filter clause of metrics. `metricFilter` should be the same value as in 
 *  your `runReport` request 
 */ 
  
 // const metricFilter = {} 
  
 /** 
 *  Filters the dimensions and metrics in the response to just this 
 *  compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` 
 *  to only return compatible dimensions & metrics. 
 */ 
  
 // const compatibilityFilter = {} 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 '@ 
 google 
 - 
  @ 
 google 
 - 
 analytics 
 / 
 data 
 
a ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
 Betanew 
  
  BetaAnalyticsDataClient 
 
 () 
 nc 
  
 function 
  
 callCheckCompatibility 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 checkCompatibility 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCheckCompatibility 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The resource name of the metadata to retrieve. This name field is 
 *  specified in the URL path and not URL parameters. Property is a numeric 
 *  Google Analytics GA4 Property identifier. To learn more, see where to find 
 *  your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  Example: properties/1234/metadata 
 *  Set the Property ID to 0 for dimensions and metrics common to all 
 *  properties. In this special mode, this method will not return custom 
 *  dimensions and metrics. 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callGetMetadata 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 getMetadata 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callGetMetadata 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. 
 *  Specified in the URL path and not the body. To learn more, see where to 
 *  find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  Within a batch request, this property should either be unspecified or 
 *  consistent with the batch-level property. 
 *  Example: properties/1234 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  The dimensions requested. All defined dimensions must be used by one of the 
 *  following: dimension_expression, dimension_filter, pivots, order_bys. 
 */ 
  
 // const dimensions = 1234 
  
 /** 
 *  The metrics requested, at least one metric needs to be specified. All 
 *  defined metrics must be used by one of the following: metric_expression, 
 *  metric_filter, order_bys. 
 */ 
  
 // const metrics = 1234 
  
 /** 
 *  The date range to retrieve event data for the report. If multiple date 
 *  ranges are specified, event data from each date range is used in the 
 *  report. A special dimension with field name "dateRange" can be included in 
 *  a Pivot's field names; if included, the report compares between date 
 *  ranges. In a cohort request, this `dateRanges` must be unspecified. 
 */ 
  
 // const dateRanges = 1234 
  
 /** 
 *  Describes the visual format of the report's dimensions in columns or rows. 
 *  The union of the fieldNames (dimension names) in all pivots must be a 
 *  subset of dimension names defined in Dimensions. No two pivots can share a 
 *  dimension. A dimension is only visible if it appears in a pivot. 
 */ 
  
 // const pivots = 1234 
  
 /** 
 *  The filter clause of dimensions. Dimensions must be requested to be used in 
 *  this filter. Metrics cannot be used in this filter. 
 */ 
  
 // const dimensionFilter = {} 
  
 /** 
 *  The filter clause of metrics. Applied at post aggregation phase, similar to 
 *  SQL having-clause. Metrics must be requested to be used in this filter. 
 *  Dimensions cannot be used in this filter. 
 */ 
  
 // const metricFilter = {} 
  
 /** 
 *  A currency code in ISO4217 format, such as "AED", "USD", "JPY". 
 *  If the field is empty, the report uses the property's default currency. 
 */ 
  
 // const currencyCode = 'abc123' 
  
 /** 
 *  Cohort group associated with this request. If there is a cohort group 
 *  in the request the 'cohort' dimension must be present. 
 */ 
  
 // const cohortSpec = {} 
  
 /** 
 *  If false or unspecified, each row with all metrics equal to 0 will not be 
 *  returned. If true, these rows will be returned if they are not separately 
 *  removed by a filter. 
 */ 
  
 // const keepEmptyRows = true 
  
 /** 
 *  Toggles whether to return the current state of this Analytics Property's 
 *  quota. Quota is returned in PropertyQuota (#PropertyQuota). 
 */ 
  
 // const returnPropertyQuota = true 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callRunPivotReport 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 runPivotReport 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRunPivotReport 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. 
 *  Specified in the URL path and not the body. To learn more, see where to 
 *  find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  Example: properties/1234 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  The dimensions requested and displayed. 
 */ 
  
 // const dimensions = 1234 
  
 /** 
 *  The metrics requested and displayed. 
 */ 
  
 // const metrics = 1234 
  
 /** 
 *  The filter clause of dimensions. Metrics cannot be used in this filter. 
 */ 
  
 // const dimensionFilter = {} 
  
 /** 
 *  The filter clause of metrics. Applied at post aggregation phase, similar to 
 *  SQL having-clause. Dimensions cannot be used in this filter. 
 */ 
  
 // const metricFilter = {} 
  
 /** 
 *  The number of rows to return. If unspecified, 10,000 rows are returned. The 
 *  API returns a maximum of 100,000 rows per request, no matter how many you 
 *  ask for. `limit` must be positive. 
 *  The API can also return fewer rows than the requested `limit`, if there 
 *  aren't as many dimension values as the `limit`. For instance, there are 
 *  fewer than 300 possible values for the dimension `country`, so when 
 *  reporting on only `country`, you can't get more than 300 rows, even if you 
 *  set `limit` to a higher value. 
 */ 
  
 // const limit = 1234 
  
 /** 
 *  Aggregation of metrics. Aggregated metric values will be shown in rows 
 *  where the dimension_values are set to "RESERVED_(MetricAggregation)". 
 */ 
  
 // const metricAggregations = 1234 
  
 /** 
 *  Specifies how rows are ordered in the response. 
 */ 
  
 // const orderBys = 1234 
  
 /** 
 *  Toggles whether to return the current state of this Analytics Property's 
 *  Realtime quota. Quota is returned in PropertyQuota (#PropertyQuota). 
 */ 
  
 // const returnPropertyQuota = true 
  
 /** 
 *  The minute ranges of event data to read. If unspecified, one minute range 
 *  for the last 30 minutes will be used. If multiple minute ranges are 
 *  requested, each response row will contain a zero based minute range index. 
 *  If two minute ranges overlap, the event data for the overlapping minutes is 
 *  included in the response rows for both minute ranges. 
 */ 
  
 // const minuteRanges = 1234 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callRunRealtimeReport 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 runRealtimeReport 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRunRealtimeReport 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  A Google Analytics GA4 property identifier whose events are tracked. 
 *  Specified in the URL path and not the body. To learn more, see where to 
 *  find your Property 
 *  ID (https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). 
 *  Within a batch request, this property should either be unspecified or 
 *  consistent with the batch-level property. 
 *  Example: properties/1234 
 */ 
  
 // const property = 'abc123' 
  
 /** 
 *  The dimensions requested and displayed. 
 */ 
  
 // const dimensions = 1234 
  
 /** 
 *  The metrics requested and displayed. 
 */ 
  
 // const metrics = 1234 
  
 /** 
 *  Date ranges of data to read. If multiple date ranges are requested, each 
 *  response row will contain a zero based date range index. If two date 
 *  ranges overlap, the event data for the overlapping days is included in the 
 *  response rows for both date ranges. In a cohort request, this `dateRanges` 
 *  must be unspecified. 
 */ 
  
 // const dateRanges = 1234 
  
 /** 
 *  Dimension filters allow you to ask for only specific dimension values in 
 *  the report. To learn more, see Fundamentals of Dimension 
 *  Filters (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) 
 *  for examples. Metrics cannot be used in this filter. 
 */ 
  
 // const dimensionFilter = {} 
  
 /** 
 *  The filter clause of metrics. Applied after aggregating the report's rows, 
 *  similar to SQL having-clause. Dimensions cannot be used in this filter. 
 */ 
  
 // const metricFilter = {} 
  
 /** 
 *  The row count of the start row. The first row is counted as row 0. 
 *  When paging, the first request does not specify offset; or equivalently, 
 *  sets offset to 0; the first request returns the first `limit` of rows. The 
 *  second request sets offset to the `limit` of the first request; the second 
 *  request returns the second `limit` of rows. 
 *  To learn more about this pagination parameter, see 
 *  Pagination (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). 
 */ 
  
 // const offset = 1234 
  
 /** 
 *  The number of rows to return. If unspecified, 10,000 rows are returned. The 
 *  API returns a maximum of 100,000 rows per request, no matter how many you 
 *  ask for. `limit` must be positive. 
 *  The API can also return fewer rows than the requested `limit`, if there 
 *  aren't as many dimension values as the `limit`. For instance, there are 
 *  fewer than 300 possible values for the dimension `country`, so when 
 *  reporting on only `country`, you can't get more than 300 rows, even if you 
 *  set `limit` to a higher value. 
 *  To learn more about this pagination parameter, see 
 *  Pagination (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). 
 */ 
  
 // const limit = 1234 
  
 /** 
 *  Aggregation of metrics. Aggregated metric values will be shown in rows 
 *  where the dimension_values are set to "RESERVED_(MetricAggregation)". 
 */ 
  
 // const metricAggregations = 1234 
  
 /** 
 *  Specifies how rows are ordered in the response. 
 */ 
  
 // const orderBys = 1234 
  
 /** 
 *  A currency code in ISO4217 format, such as "AED", "USD", "JPY". 
 *  If the field is empty, the report uses the property's default currency. 
 */ 
  
 // const currencyCode = 'abc123' 
  
 /** 
 *  Cohort group associated with this request. If there is a cohort group 
 *  in the request the 'cohort' dimension must be present. 
 */ 
  
 // const cohortSpec = {} 
  
 /** 
 *  If false or unspecified, each row with all metrics equal to 0 will not be 
 *  returned. If true, these rows will be returned if they are not separately 
 *  removed by a filter. 
 */ 
  
 // const keepEmptyRows = true 
  
 /** 
 *  Toggles whether to return the current state of this Analytics Property's 
 *  quota. Quota is returned in PropertyQuota (#PropertyQuota). 
 */ 
  
 // const returnPropertyQuota = true 
  
 // Imports the Data library 
  
 const 
  
 { 
 BetaAnalyticsDataClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-analytics/data 
' 
 ). 
 v1beta 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataClient 
  
 = 
  
 new 
  
  BetaAnalyticsDataClient 
 
 (); 
  
 async 
  
 function 
  
 callRunReport 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataClient 
 . 
 runReport 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRunReport 
 ();