import { INodeProperties, } from 'n8n-workflow'; export const reportOperations: INodeProperties[] = [ { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'report', ], }, }, options: [ { name: 'Get', value: 'get', description: 'Return the analytics data', }, ], default: 'get', description: 'The operation to perform.', }, ]; export const reportFields: INodeProperties[] = [ { displayName: 'View ID', name: 'viewId', type: 'options', typeOptions: { loadOptionsMethod: 'getViews', }, default: '', required: true, displayOptions: { show: { resource: [ 'report', ], operation: [ 'get', ], }, }, placeholder: '123456', description: 'The View ID of Google Analytics', }, { displayName: 'Return All', name: 'returnAll', type: 'boolean', displayOptions: { show: { operation: [ 'get', ], resource: [ 'report', ], }, }, default: false, description: 'If all results should be returned or only up to a given limit.', }, { displayName: 'Limit', name: 'limit', type: 'number', displayOptions: { show: { operation: [ 'get', ], resource: [ 'report', ], returnAll: [ false, ], }, }, typeOptions: { minValue: 1, maxValue: 1000, }, default: 1000, description: 'How many results to return.', }, { displayName: 'Simplify Response', name: 'simple', type: 'boolean', displayOptions: { show: { operation: [ 'get', ], resource: [ 'report', ], }, }, default: true, description: 'Return a simplified version of the response instead of the raw data.', }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', placeholder: 'Add Field', default: {}, displayOptions: { show: { resource: [ 'report', ], operation: [ 'get', ], }, }, options: [ { displayName: 'Date Ranges', name: 'dateRangesUi', placeholder: 'Add Date Range', type: 'fixedCollection', default: {}, description: 'Date ranges in the request', options: [ { displayName: 'Date Range', name: 'dateRanges', values: [ { displayName: 'Start Date', name: 'startDate', type: 'dateTime', default: '', }, { displayName: 'End Date', name: 'endDate', type: 'dateTime', default: '', }, ], }, ], }, { displayName: 'Dimensions', name: 'dimensionUi', type: 'fixedCollection', default: {}, typeOptions: { multipleValues: true, }, placeholder: 'Add Dimension', description: 'Dimensions are attributes of your data. For example, the dimension ga:city indicates the city, for example, "Paris" or "New York", from which a session originates.', options: [ { displayName: 'Dimension', name: 'dimensionValues', values: [ { displayName: 'Name', name: 'name', type: 'options', typeOptions: { loadOptionsMethod: 'getDimensions', }, default: '', description: 'Name of the dimension to fetch, for example ga:browser.', }, ], }, ], }, { displayName: 'Dimension Filters', name: 'dimensionFiltersUi', type: 'fixedCollection', default: {}, typeOptions: { multipleValues: true, }, placeholder: 'Add Dimension Filter', description: 'Dimension Filters in the request', options: [ { displayName: 'Filters', name: 'filterValues', values: [ { displayName: 'Dimension Name', name: 'dimensionName', type: 'options', typeOptions: { loadOptionsMethod: 'getDimensions', }, default: '', description: 'Name of the dimension to filter by.', }, // https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/reports/batchGet#Operator { displayName: 'Operator', name: 'operator', type: 'options', default: 'EXACT', description: 'Operator to use in combination with value.', options: [ { name: 'Begins With', value: 'BEGINS_WITH', }, { name: 'Ends With', value: 'ENDS_WITH', }, { name: 'Exact', value: 'EXACT', }, { name: 'Greater Than (number)', value: 'NUMERIC_GREATER_THAN', }, { name: 'Partial', value: 'PARTIAL', }, { name: 'Regular Expression', value: 'REGEXP', }, { name: 'Equal (number)', value: 'NUMERIC_EQUAL', }, { name: 'Less Than (number)', value: 'NUMERIC_LESS_THAN', }, ], }, { displayName: 'Value', name: 'expressions', type: 'string', default: '', placeholder: 'ga:newUsers', description: `String or regular expression to match against.`, }, ], }, ], }, { displayName: 'Hide Totals', name: 'hideTotals', type: 'boolean', default: false, description: 'If set to true, hides the total of all metrics for all the matching rows, for every date range.', }, { displayName: 'Hide Value Ranges', name: 'hideValueRanges', type: 'boolean', default: false, description: 'If set to true, hides the minimum and maximum across all matching rows.', }, { displayName: 'Include Empty Rows', name: 'includeEmptyRows', type: 'boolean', default: false, description: 'If set to false, the response exclude rows if all the retrieved metrics are equal to zero.', }, { displayName: 'Metrics', name: 'metricsUi', type: 'fixedCollection', default: {}, typeOptions: { multipleValues: true, }, placeholder: 'Add Metrics', description: 'Metrics in the request', options: [ { displayName: 'Metric', name: 'metricValues', values: [ { displayName: 'Alias', name: 'alias', type: 'string', default: '', description: 'An alias for the metric expression is an alternate name for the expression. The alias can be used for filtering and sorting.', }, { displayName: 'Expression', name: 'expression', type: 'string', default: 'ga:newUsers', description: '

A metric expression in the request. An expression is constructed from one or more metrics and numbers.

Accepted operators include: Plus (+), Minus (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive cardinal numbers (0-9), can include decimals and is limited to 1024 characters.

Example ga:totalRefunds/ga:users, in most cases the metric expression is just a single metric name like ga:users.

Adding mixed MetricType (E.g., CURRENCY + PERCENTAGE) metrics will result in unexpected results.

.', }, { displayName: 'Formatting Type', name: 'formattingType', type: 'options', default: 'INTEGER', description: 'Specifies how the metric expression should be formatted.', options: [ { name: 'Currency', value: 'CURRENCY', }, { name: 'Float', value: 'FLOAT', }, { name: 'Integer', value: 'INTEGER', }, { name: 'Percent', value: 'PERCENT', }, { name: 'Time', value: 'TIME', }, ], }, ], }, ], }, { displayName: 'Use Resource Quotas', name: 'useResourceQuotas', type: 'boolean', default: false, description: 'Enables resource based quotas.', }, ], }, ];