Add Google Search Console plugin for monitoring site performance data

plugins/GoogleSearchConsole/v1/dataStreams/countryBreakdown.json

@@ -0,0 +1,31 @@
+{
+    "name": "countryBreakdown",
+    "displayName": "Country breakdown",
+    "description": "Returns search performance metrics grouped by country",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "country"
+            ],
+            "rowLimit": 25000,
+            "dataState": "final"
+        },
+        "postRequestScript": "postRequest/countryBreakdown.js",
+        "getArgs": [],
+        "headers": []
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": []
+}

plugins/GoogleSearchConsole/v1/dataStreams/deviceBreakdown.json

@@ -0,0 +1,31 @@
+{
+    "name": "deviceBreakdown",
+    "displayName": "Device breakdown",
+    "description": "Returns search performance metrics grouped by device type",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "device"
+            ],
+            "rowLimit": 25000,
+            "dataState": "final"
+        },
+        "postRequestScript": "postRequest/deviceBreakdown.js",
+        "getArgs": [],
+        "headers": []
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": []
+}

plugins/GoogleSearchConsole/v1/dataStreams/pageDistribution.json

@@ -0,0 +1,59 @@
+{
+    "name": "pageDistribution",
+    "displayName": "Page distribution",
+    "description": "Returns a distribution of queries by search ranking position for the selected page",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "getArgs": [],
+        "headers": [],
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "query"
+            ],
+            "dimensionFilterGroups": [
+                {
+                    "filters": [
+                        {
+                            "dimension": "page",
+                            "operator": "equals",
+                            "expression": "{{scope?.[0]?.name}}"
+                        }
+                    ]
+                }
+            ],
+            "rowLimit": 25000
+        },
+        "postRequestScript": "postRequest/pageDistribution.js"
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": [],
+
+    "ui": [
+        {
+            "name": "scope",
+            "objectLimit": 1,
+            "label": "Scope",
+            "type": "objects",
+            "matches": {
+                "sourceType": {
+                    "type": "equals",
+                    "value": "gsc-page"
+                }
+            },
+            "validation": {
+                "required": true
+            }
+        }
+    ]
+}

plugins/GoogleSearchConsole/v1/dataStreams/pagePerformanceOverTime.json

@@ -0,0 +1,59 @@
+{
+    "name": "pagePerformanceOverTime",
+    "displayName": "Page performance over time",
+    "description": "Returns daily clicks, impressions and CTR trends for the selected page",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "date"
+            ],
+            "dimensionFilterGroups": [
+                {
+                    "filters": [
+                        {
+                            "dimension": "page",
+                            "operator": "equals",
+                            "expression": "{{scope?.[0]?.name}}"
+                        }
+                    ]
+                }
+            ],
+            "rowLimit": 25000
+        },
+        "postRequestScript": "postRequest/pagePerformanceOverTime.js",
+        "getArgs": [],
+        "headers": []
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": [],
+
+    "ui": [
+        {
+            "name": "scope",
+            "objectLimit": 1,
+            "label": "Scope",
+            "type": "objects",
+            "matches": {
+                "sourceType": {
+                    "type": "equals",
+                    "value": "gsc-page"
+                }
+            },
+            "validation": {
+                "required": true
+            }
+        }
+    ]
+}

plugins/GoogleSearchConsole/v1/dataStreams/pagePerformanceSummary.json

@@ -0,0 +1,59 @@
+{
+    "name": "pagePerformanceSummary",
+    "displayName": "Page performance summary",
+    "description": "Returns performance metrics for a given page",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "getArgs": [],
+        "headers": [],
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "page"
+            ],
+            "dimensionFilterGroups": [
+                {
+                    "filters": [
+                        {
+                            "dimension": "page",
+                            "operator": "equals",
+                            "expression": "{{scope?.[0]?.name}}"
+                        }
+                    ]
+                }
+            ],
+            "rowLimit": 25000
+        },
+        "postRequestScript": "postRequest/script1.js"
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": [],
+
+    "ui": [
+        {
+            "name": "scope",
+            "objectLimit": 1,
+            "label": "Scope",
+            "type": "objects",
+            "matches": {
+                "sourceType": {
+                    "type": "equals",
+                    "value": "gsc-page"
+                }
+            },
+            "validation": {
+                "required": true
+            }
+        }
+    ]
+}

plugins/GoogleSearchConsole/v1/dataStreams/pageUrLs.json

@@ -0,0 +1,30 @@
+{
+    "name": "pageUrLs",
+    "displayName": "Page URLs",
+    "description": "Returns a list off URLs with impressions in the last year",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "postBody": {
+            "startDate": "{{new Date(Date.now() - 365 * 24 * 60 * 60 * 1000).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date().toISOString().split('T')[0]}}",
+            "dimensions": [
+                "page"
+            ],
+            "rowLimit": 25
+        },
+        "postRequestScript": "postRequest/pageUrLs.js",
+        "getArgs": [],
+        "headers": []
+    },
+    "timeframes": false,
+    "providesPluginDiagnostics": true,
+    "tags": []
+}

plugins/GoogleSearchConsole/v1/dataStreams/pages.json

@@ -0,0 +1,30 @@
+{
+    "name": "pages",
+    "displayName": "Pages",
+    "description": "Returns a complete list of pages with performance metrics",
+    "baseDataSourceName": "httpRequestUnscoped",
+    "config": {
+        "httpMethod": "post",
+        "errorHandling": {
+            "type": "default"
+        },
+        "paging": {
+            "mode": "none"
+        },
+        "expandInnerObjects": true,
+        "postBody": {
+            "startDate": "{{new Date(timeframe.start).toISOString().split('T')[0]}}",
+            "endDate": "{{new Date(timeframe.end).toISOString().split('T')[0]}}",
+            "dimensions": [
+                "page"
+            ],
+            "rowLimit": 25000
+        },
+        "postRequestScript": "postRequest/pages.js",
+        "getArgs": [],
+        "headers": []
+    },
+    "providesPluginDiagnostics": true,
+    "timeframes": true,
+    "tags": []
+}

plugins/GoogleSearchConsole/v1/dataStreams/previousPeriodPagePerformance.json

@@ -0,0 +1,59 @@
+{
+  "name": "previousPeriodPagePerformance",
+  "displayName": "Previous period page performance",
+  "description": "Returns a summary of performance for the previous period of a given timeframe for the selected page",
+  "baseDataSourceName": "httpRequestUnscoped",
+  "config": {
+    "httpMethod": "post",
+    "errorHandling": {
+      "type": "default"
+    },
+    "paging": {
+      "mode": "none"
+    },
+    "expandInnerObjects": true,
+    "getArgs": [],
+    "headers": [],
+    "postBody": {
+      "startDate": "{{new Date(new Date(timeframe.start).getTime() - (new Date(timeframe.end).getTime() - new Date(timeframe.start).getTime()) - 86400000).toISOString().split('T')[0]}}",
+      "endDate": "{{new Date(new Date(timeframe.start).getTime() - 86400000).toISOString().split('T')[0]}}",
+      "dimensions": ["page"],
+      "dimensionFilterGroups": [
+        {
+          "filters": [
+            {
+              "dimension": "page",
+              "operator": "equals",
+              "expression": "{{scope?.[0]?.name}}"
+            }
+          ]
+        }
+      ],
+      "rowLimit": 25000
+    },
+    "postRequestScript": "postRequest/script1.js"
+  },
+  "timeframes": true,
+  "providesPluginDiagnostics": true,
+  "tags": [],
+  "visibility": {
+    "type": "hidden"
+  },
+  "ui": [
+    {
+      "name": "scope",
+      "objectLimit": 1,
+      "label": "Scope",
+      "type": "objects",
+      "matches": {
+        "sourceType": {
+          "type": "equals",
+          "value": "gsc-page"
+        }
+      },
+      "validation": {
+        "required": true
+      }
+    }
+  ]
+}