@adobe/spacecat-shared-google-client 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-google-client-v1.1.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.0.2...@adobe/spacecat-shared-google-client-v1.1.0) (2024-05-24)
+
+
+### Features
+
+* filter fetched organic search data from google by base url ([#239](https://github.com/adobe/spacecat-shared/issues/239)) ([0bfba19](https://github.com/adobe/spacecat-shared/commit/0bfba19d08122c969f513154c697dd75017b8e43))
+
+# [@adobe/spacecat-shared-google-client-v1.0.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.0.1...@adobe/spacecat-shared-google-client-v1.0.2) (2024-05-22)
+
+
+### Bug Fixes
+
+* getOrganicSearchData interface params ([#236](https://github.com/adobe/spacecat-shared/issues/236)) ([acfd48b](https://github.com/adobe/spacecat-shared/commit/acfd48baaaa7594d0b9d7f00f7c9d52118b137e9))
+
 # [@adobe/spacecat-shared-google-client-v1.0.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-google-client-v1.0.0...@adobe/spacecat-shared-google-client-v1.0.1) (2024-05-21)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-google-client",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Shared modules of the Spacecat Services - Google Client",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -10,18 +10,17 @@
  * governing permissions and limitations under the License.
  */
 
-import { UniversalContext } from '@adobe/helix-universal';
 import { OAuth2Client } from 'google-auth-library';
 
 export default class GoogleClient {
   /**
    * Static factory method to create an instance of GoogleClient.
    *
-   * @param {UniversalContext} context - An object containing the AWS Lambda context information
+   * @param {object} context - An object containing the AWS Lambda context information
    * @param {string} url - The URL of the site to be audited.
    * @returns An instance of GoogleClient.
    */
-  static createFrom(context: UniversalContext, url: string): GoogleClient;
+  static createFrom(context: object, url: string): GoogleClient;
 
   /**
    * Constructor for creating an instance of GoogleClient.
@@ -33,12 +32,13 @@ export default class GoogleClient {
   /**
    * Retrieves the Google Search Console data for the specified date range.
    *
-   * @param baseURL - The base URL of the site to be audited.
-   * @param startDate - The start date of the date range.
-   * @param endDate - The end date of the date range.
-   * @param dimensions - The dimensions to be included in the report.
+   * @param {Date} startDate - The start date of the date range.
+   * @param {Date} endDate - The end date of the date range.
+   * @param {Array} dimensions - The dimensions to be included in the report.
    * this parameter is optional and defaults to ['date'],
    * which means that the report will be grouped by date.
+   * @param {Number} rowLimit - The maximum number of rows to return, defaults to 1000.
+   * @param {Number} startRow - The row number to start from, defaults to 0.
    * @returns {Promise<JSON>} The Google Search Console data.
    * Format: {
    *   "rows": [
@@ -56,10 +56,11 @@ export default class GoogleClient {
    * }
    */
   getOrganicSearchData(
-    baseURL: string,
     startDate: Date,
     endDate: Date,
-    dimensions: string[]
+    dimensions?: string[],
+    rowLimit?: number,
+    startRow?: number
   ): Promise<JSON>;
 
   /**

package/src/index.js

@@ -14,14 +14,19 @@ import { google } from 'googleapis';
 import { OAuth2Client } from 'google-auth-library';
 import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import {
+  composeAuditURL,
   isArray,
   isInteger,
-  isValidDate,
+  isValidDate, isValidUrl,
   resolveCustomerSecretsName,
 } from '@adobe/spacecat-shared-utils';
 
 export default class GoogleClient {
   static async createFrom(context, baseURL) {
+    if (!isValidUrl(baseURL)) {
+      throw new Error('Error creating GoogleClient: Invalid base URL');
+    }
+
     try {
       const customerSecret = resolveCustomerSecretsName(baseURL, context);
       const client = new SecretsManagerClient({});
@@ -36,6 +41,7 @@ export default class GoogleClient {
         tokenType: secrets.token_type,
         expiryDate: secrets.expiry_date,
         siteUrl: secrets.site_url,
+        baseUrl: baseURL,
         clientId: context.env.GOOGLE_CLIENT_ID,
         clientSecret: context.env.GOOGLE_CLIENT_SECRET,
         redirectUri: context.env.GOOGLE_REDIRECT_URI,
@@ -61,6 +67,10 @@ export default class GoogleClient {
       throw new Error('Missing refresh token in secret');
     }
 
+    if (!isValidUrl(config.siteUrl)) {
+      throw new Error('Invalid site URL in secret');
+    }
+
     authClient.setCredentials({
       access_token: config.accessToken,
       refresh_token: config.refreshToken,
@@ -69,6 +79,7 @@ export default class GoogleClient {
     this.authClient = authClient;
     this.expiryDate = config.expiryDate;
     this.siteUrl = config.siteUrl;
+    this.baseUrl = config.baseUrl;
     this.log = log;
   }
 
@@ -100,6 +111,8 @@ export default class GoogleClient {
 
     await this.#refreshTokenIfExpired();
 
+    const auditUrl = await composeAuditURL(this.baseUrl);
+
     const webmasters = google.webmasters({
       version: 'v3',
       auth: this.authClient,
@@ -115,6 +128,17 @@ export default class GoogleClient {
           dimensions,
           startRow,
           rowLimit,
+          dimensionFilterGroups: [
+            {
+              filters: [
+                {
+                  dimension: 'page',
+                  operator: 'contains',
+                  expression: auditUrl,
+                },
+              ],
+            },
+          ],
         },
       };
       this.log.info(`Retrieving organic search data: ${JSON.stringify(params)}`);