Add pagination to resource report for Google Analytics (#1755)

This commit is contained in:
Ricardo Espinoza 2021-05-08 16:26:06 -04:00 committed by GitHub
parent 77da5b70bc
commit 3a1a5fd49c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 107 additions and 43 deletions

View file

@ -27,11 +27,13 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
}; };
options = Object.assign({}, options, option); options = Object.assign({}, options, option);
try { try {
if (Object.keys(body).length === 0) { if (Object.keys(body).length === 0) {
delete options.body; delete options.body;
} }
if (Object.keys(qs).length === 0) {
delete options.qs;
}
//@ts-ignore //@ts-ignore
return await this.helpers.requestOAuth2.call(this, 'googleAnalyticsOAuth2', options); return await this.helpers.requestOAuth2.call(this, 'googleAnalyticsOAuth2', options);
@ -45,12 +47,11 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
const returnData: IDataObject[] = []; const returnData: IDataObject[] = [];
let responseData; let responseData;
body.pageSize = 100;
do { do {
responseData = await googleApiRequest.call(this, method, endpoint, body, query, uri); responseData = await googleApiRequest.call(this, method, endpoint, body, query, uri);
if (body.reportRequests && Array.isArray(body.reportRequests)) { if (body.reportRequests && Array.isArray(body.reportRequests)) {
body.reportRequests[0].pageToken = responseData['nextPageToken']; body.reportRequests[0]['pageToken'] = responseData[propertyName][0].nextPageToken;
} else { } else {
body.pageToken = responseData['nextPageToken']; body.pageToken = responseData['nextPageToken'];
} }
@ -58,17 +59,17 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
} while ( } while (
(responseData['nextPageToken'] !== undefined && (responseData['nextPageToken'] !== undefined &&
responseData['nextPageToken'] !== '') || responseData['nextPageToken'] !== '') ||
(responseData['reports'] && (responseData[propertyName] &&
responseData['reports'][0].nextPageToken && responseData[propertyName][0].nextPageToken &&
responseData['reports'][0].nextPageToken !== undefined) responseData[propertyName][0].nextPageToken !== undefined)
); );
return returnData; return returnData;
} }
export function simplify(responseData: any) { // tslint:disable-line:no-any export function simplify(responseData: any | [any]) { // tslint:disable-line:no-any
const { columnHeader: { dimensions }, data: { rows } } = responseData[0]; const response = [];
responseData = []; for (const { columnHeader: { dimensions }, data: { rows } } of responseData) {
for (const row of rows) { for (const row of rows) {
const data: IDataObject = {}; const data: IDataObject = {};
if (dimensions) { if (dimensions) {
@ -79,7 +80,21 @@ export function simplify(responseData: any) { // tslint:disable-line:no-any
} else { } else {
data['total'] = row.metrics[0].values.join(','); data['total'] = row.metrics[0].values.join(',');
} }
responseData.push(data); response.push(data);
} }
return responseData; }
return response;
}
export function merge(responseData: [any]) { // tslint:disable-line:no-any
const response: { columnHeader: IDataObject, data: { rows: [] } } = {
columnHeader: responseData[0].columnHeader,
data: responseData[0].data,
};
const allRows = [];
for (const { data: { rows } } of responseData) {
allRows.push(...rows);
}
response.data.rows = allRows as [];
return [response];
} }

View file

@ -24,13 +24,14 @@ import {
import { import {
googleApiRequest, googleApiRequest,
googleApiRequestAllItems, googleApiRequestAllItems,
merge,
simplify, simplify,
} from './GenericFunctions'; } from './GenericFunctions';
import * as moment from 'moment-timezone'; import * as moment from 'moment-timezone';
import { import {
IData IData,
} from './Interfaces'; } from './Interfaces';
export class GoogleAnalytics implements INodeType { export class GoogleAnalytics implements INodeType {
@ -158,6 +159,7 @@ export class GoogleAnalytics implements INodeType {
method = 'POST'; method = 'POST';
endpoint = '/v4/reports:batchGet'; endpoint = '/v4/reports:batchGet';
const viewId = this.getNodeParameter('viewId', i) as string; const viewId = this.getNodeParameter('viewId', i) as string;
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
const additionalFields = this.getNodeParameter( const additionalFields = this.getNodeParameter(
'additionalFields', 'additionalFields',
i, i,
@ -211,11 +213,17 @@ export class GoogleAnalytics implements INodeType {
Object.assign(body, { hideTotals: additionalFields.hideTotals }); Object.assign(body, { hideTotals: additionalFields.hideTotals });
} }
if (returnAll === true) {
responseData = await googleApiRequestAllItems.call(this, 'reports', method, endpoint, { reportRequests: [body] }, qs);
} else {
responseData = await googleApiRequest.call(this, method, endpoint, { reportRequests: [body] }, qs); responseData = await googleApiRequest.call(this, method, endpoint, { reportRequests: [body] }, qs);
responseData = responseData.reports; responseData = responseData.reports;
}
if (simple === true) { if (simple === true) {
responseData = simplify(responseData); responseData = simplify(responseData);
} else if (returnAll === true && responseData.length > 1) {
responseData = merge(responseData);
} }
} }
} }

View file

@ -49,6 +49,47 @@ export const reportFields = [
placeholder: '123456', placeholder: '123456',
description: 'The View ID of Google Analytics', 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: 'Simple', displayName: 'Simple',
name: 'simple', name: 'simple',