Skip to content

Commit c78b17f

Browse files
HrithikSampsonHrithikSampson
committed
feat: Deploying Appwrite function to report appwrite event to google analytics
1 parent 954c0c0 commit c78b17f

File tree

8 files changed

+793
-0
lines changed

8 files changed

+793
-0
lines changed

‎appwrite.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"projectId": "6524d42869dc1c9786e5",
3+
"projectName": "Personal Project"
4+
}

‎node/events-to-ga/.gitignore

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

‎node/events-to-ga/README.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<!-- Name your function -->
2+
3+
# ⚡ Template Function
4+
5+
<!-- Write short function tagline -->
6+
7+
The function will be triggered by configured Appwrite events and report these events to Google Analytics.
8+
9+
## 🧰 Usage
10+
11+
<!-- Copy section for each endpoint -->
12+
<!-- Document endpoint method and url -->
13+
14+
### POST /
15+
16+
<!-- Describe the endpoint -->
17+
18+
Gets the event from the header.
19+
20+
**Parameters**
21+
22+
<!-- Document each expected parameter -->
23+
24+
| Name | Description | Location | Type | Sample Value |
25+
| ------------------ | ------------------------------ | -------- | ------ | --------------------- |
26+
| x-appwrite-user-id | User ID from Appwrite. | Header | String | 642...7cd |
27+
| x-appwrite-event | Describes the triggering event | Header | String | users.65...f19.delete |
28+
| x-appwrite-trigger | Type of trigger for function | Header | String | event |
29+
30+
**Response**
31+
32+
<!-- Provide sample body for successful response -->
33+
34+
Sample `200` Response:
35+
36+
```json
37+
{
38+
"ok": true,
39+
"message": "event users.653...df19.delete is send to google analytics",
40+
}
41+
```
42+
43+
<!-- If relevant, document error responses -->
44+
45+
Sample `503` Response:
46+
47+
```json
48+
{ "ok": false, "message": "Response status code when posting event to Google Analytics is 503" }
49+
```
50+
51+
Sample `401` Response:
52+
53+
```json
54+
{ "ok": false, "message": "Error Posting Event to Google Analytics" }
55+
```
56+
## ⚙️ Configuration
57+
58+
<!-- Update values and remove irrelevant settings -->
59+
60+
| Setting | Value |
61+
| ----------------- | ---------------- |
62+
| Runtime | Node (18.0) |
63+
| Entrypoint | `src/main.js` |
64+
| Build Commands | `npm install` |
65+
| Permissions | `any` |
66+
| Events | all |
67+
68+
## 🔒 Environment Variables
69+
70+
<!-- Copy section for each variable -->
71+
<!-- Name the variable -->
72+
73+
74+
### APPWRITE_FUNCTION_PROJECT_ID
75+
76+
<!-- Describe the variable -->
77+
78+
Project ID in which Appwrite Function is added.
79+
80+
<!-- Mark if variable is required or not -->
81+
<!-- Provide sample (but invalid) value -->
82+
<!-- Link to docs or remove if irrelevant -->
83+
84+
| Question | Answer |
85+
| ------------- | -------------------------------------------------------------------------------------------------------------|
86+
| Required | Yes |
87+
| Sample Value | `6524d.....6e5` |
88+
| Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) |
89+
90+
91+
### GA4_Measurement_Id
92+
93+
<!-- Describe the variable -->
94+
95+
API Key to talk to Appwrite backend APIs.
96+
97+
<!-- Mark if variable is required or not -->
98+
<!-- Provide sample (but invalid) value -->
99+
<!-- Link to docs or remove if irrelevant -->
100+
101+
| Question | Answer |
102+
| ------------- | --------------------------------------------------------------------------------------------------------------|
103+
| Required | Yes |
104+
| Sample Value | `G-NY5...26R` |
105+
| Documentation | [Google Analytics 4 docs](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference)|
106+
107+
108+
### APPWRITE_ENDPOINT
109+
110+
<!-- Describe the variable -->
111+
112+
API Key to talk to Appwrite backend APIs.
113+
114+
<!-- Mark if variable is required or not -->
115+
<!-- Provide sample (but invalid) value -->
116+
<!-- Link to docs or remove if irrelevant -->
117+
118+
| Question | Answer |
119+
| ------------- | --------------------------------------------------------------------------------------------------------------|
120+
| Required | Yes |
121+
| Sample Value | `https://cloud.appwrite.io/v1` |
122+
| Documentation | [Google Analytics 4 docs](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference)|
123+
124+
### GA4_API_SECRET
125+
126+
<!-- Describe the variable -->
127+
128+
API Key to talk to Appwrite backend APIs.
129+
130+
<!-- Mark if variable is required or not -->
131+
<!-- Provide sample (but invalid) value -->
132+
<!-- Link to docs or remove if irrelevant -->
133+
134+
| Question | Answer |
135+
| ------------- | --------------------------------------------------------------------------------------------------------------|
136+
| Required | Yes / No |
137+
| Sample Value | `d1efb...aec35` |
138+
| Documentation | [Google Analytics 4 docs](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference)|

‎node/events-to-ga/env.d.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
declare global {
2+
namespace NodeJS {
3+
interface ProcessEnv {
4+
APPWRITE_ENDPOINT: string;
5+
APPWRITE_FUNCTION_PROJECT_ID: string;
6+
APPWRITE_API_KEY: string;
7+
GA4_Measurement_Id: string;
8+
GA4_API_SECRET: string;
9+
}
10+
}
11+
}
12+
13+
export {};
14+

0 commit comments

Comments
 (0)