offen/analyticstxt
2
0
Fork 0
mirror of https://github.com/offen/analyticstxt.git synced 2024-10-22 05:40:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

figure out how to signal the absence of analytics

Browse Source
This commit is contained in:
Frederik Ring 2021-04-01 13:40:26 +02:00
parent b4349aa45c
commit e968855570
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
draft-offen-analyticstxt.md
View File

@ -126,13 +126,17 @@ The field MUST contain a valid email address which shall be used for inquiries a
Contact: Jane Doe <jane.doe@example.com> Contact: Jane Doe <jane.doe@example.com>
``` ```
### Collects ### Collects {#collects-field}
This REQUIRED multi-value field indicates which potentially privacy relevant user specific data is being collected or used in session identification. This REQUIRED multi-value field indicates which potentially privacy relevant user specific data is being collected or used in session identification.
These MUST also be specified if properties are not persisted as-is, but stored or otherwise computed in a hashed and/or combined form. These MUST also be specified if properties are not persisted as-is, but stored or otherwise computed in a hashed and/or combined form.
#### Allowed values #### Allowed values
##### none
No analytics data is collected at all.
##### ip-address ##### ip-address
The request IP address is being used. The request IP address is being used.
@ -182,7 +186,8 @@ Collects: url, device-type, referrer
### Stores ### Stores
This REQUIRED multi-value field indicates whether data is persisted on the client during the collection of analytics data and declares the browser features used for doing so. This field is REQUIRED unless the only value of the Collects field {{collects-field}} is none.
The multi-value field indicates whether data is persisted on the client during the collection of analytics data and declares the browser features used for doing so.
If no data is being persisted, the value `none` MUST be used. If no data is being persisted, the value `none` MUST be used.
#### Allowed values #### Allowed values
@ -217,7 +222,8 @@ Stores: 1st-party-cookies, local-storage
### Uses ### Uses
This REQUIRED multi-value field indicates the technical implementation details for how analytics data is being collected. This field is REQUIRED unless the only value of the Collects field {{collects-field}} is none.
The multi-value field indicates the technical implementation details for how analytics data is being collected.
#### Allowed values #### Allowed values
@ -249,7 +255,8 @@ Uses: script
### Allows ### Allows
This REQUIRED multi-value field discloses information about whether user consent is being acquired before collecting analytics data, and if it is possible for users to opt out of the collection of usage data. This field is REQUIRED unless the only value of the Collects field {{collects-field}} is none.
The multi-value field discloses information about whether user consent is being acquired before collecting analytics data, and if it is possible for users to opt out of the collection of usage data.
Existing regulations about user consent do not apply to this field. Existing regulations about user consent do not apply to this field.
#### Allowed values #### Allowed values
@ -274,7 +281,8 @@ Allows: opt-in, opt-out
### Retains ### Retains
This REQUIRED single-value field indicates the duration for which the analytics data is being stored before being delete. This field is REQUIRED unless the only value of Collects is none.
The single-value field indicates the duration for which the analytics data is being stored before being delete.
The value is a duration as defined in {{!RFC 3339}}. The value is a duration as defined in {{!RFC 3339}}.
Implementors SHOULD add a comment providing a human readable value to this field. Implementors SHOULD add a comment providing a human readable value to this field.
@ -389,7 +397,9 @@ Example values are:
Vendors: offen, hotjar Vendors: offen, hotjar
``` ```
## Example of an analytics.txt file ## Examples of analytics.txt files
### Example of a site with analytics
``` ```
# analytics.txt file for https://www.analyticstxt.org # analytics.txt file for https://www.analyticstxt.org
@ -409,7 +419,14 @@ Session: user
Variants: none Variants: none
Visibility: user Visibility: user
Compliance: gdpr Compliance: gdpr
Vendors: offen ```
### Example of a site not using any analytics
```
# analytics.txt file for https://www.frederikring.com
Author: Frederik Ring <hioffen@posteo.de>
Collects: none
``` ```
# Location of the analytics.txt file {#location} # Location of the analytics.txt file {#location}