📖 Amp-analytics: Document feature to write cookie to origin domain #19590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @lannka |
calebcordry
approved these changes
Dec 4, 2018
| @@ -695,6 +695,12 @@ Detials on setting up your linker configuration are outlined in [Linker ID Forwa | |||
|
|
|||
| If you need to ingest this paramter, information on how this parameter is created is illistrated in [Linker ID Receiving](./linker-id-receiving.md). | |||
|
|
|||
| #### Cookies | |||
|
|
|||
| The `cookies` feature supports writing cookies to the origin domain by extracting [`QUERY_PARAM`](https://github.com/ampproject/amphtml/blob/master/spec/amp-var-substitutions.md#query-parameter) and [`LINKER_PARAM`](./linker-id-receiving.md#linker-param) information from the document url. It can be used along with `linkers` features to perform ID syncing from AMP proxy domain to AMP pages on the publisher domain. | |||
There was a problem hiding this comment.
...syncing from the AMP proxied domain to AMP pages on a publisher's domain.
|
|
||
| #### Configuration | ||
|
|
||
| The `cookies` example configuration looks like |
| The `enabled` value can be used to override default vendor settings. | ||
|
|
||
| ##### Cookie Names | ||
| Each key value within the `cookies` config object defines the cookie key, where its value needs to be an object. |
There was a problem hiding this comment.
Each key within the cookies config object defines the cookie name. It's value needs to be an object containing a single key value pair. That key should be 'value', and its value should be the macro that determines the information stored in the cookie.
This is a really hard sentence because the keys name is value. Hopefully someone else will help improve :)
| ##### Cookie Values | ||
| Each cookie to write is defined by an object, where the value is defined by the required `value` field. | ||
|
|
||
| Two Macros are supported for the `value` field. [`QUERY_PARAM`](https://github.com/ampproject/amphtml/blob/master/spec/amp-var-substitutions.md#query-parameter) and [`LINKER_PARAM`](#linker-param). |
|
|
||
| Two Macros are supported for the `value` field. [`QUERY_PARAM`](https://github.com/ampproject/amphtml/blob/master/spec/amp-var-substitutions.md#query-parameter) and [`LINKER_PARAM`](#linker-param). | ||
|
|
||
| When there's error resoving the value, or the value is resolved to empty string. Nothing will be written to the cookie. |
| When there's error resoving the value, or the value is resolved to empty string. Nothing will be written to the cookie. | ||
|
|
||
| ##### LINKER PARAM | ||
| `LINKER_PARAM` takes two params, the `name` and the `value`. It will verify the checksum and read the `idName1*idValue1` key value pair from linker param. The `value` ('idValue1' here) will be returned. |
There was a problem hiding this comment.
s/params/arguments
s/from linker param/ from the linker param
|
also cc/ @CrystalFaith for docs magic |
|
@calebcordry Thank you for reviewing! Addressed comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #19589