Skip to content

Conversation

James9446
Copy link
Contributor

Proposed changes

  1. Added a warning to the top of the doc. This will be removed or modified after Feb 15th
  2. Added a Server Event Parameter Requirements section
  3. Added an Action Source subsection
  4. Added a Client User Agent subsection
  5. Added a Event Source URL subsection
  6. Addded a Implementating Server Event Parameter Requirements subsection
  7. Modified the Default Mappings to Facebook Properties section to include new parameters
  8. Fixed broken links in the Use Cases section

Merge timing

ASAP after review

@netlify
Copy link

netlify bot commented Feb 10, 2021

Deploy preview for segment-docs-preview ready!

Built with commit 22610c5

https://deploy-preview-1407--segment-docs-preview.netlify.app

Copy link
Contributor

@markzegarelli markzegarelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@James9446 Just one clarification needed.


If `action_source` = 'website' then the `context.userAgent` and the `context.page.url` fields are required. Segment server-side libraries do not automatically collect the `context.userAgent` or the `context.page.url`. This data will need to be manually grabbed from the client and passed to the server.

Example of a [`Product Added`](/docs/connections/spec/ecommerce/v2/#product-added) event using Node.js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@James9446 What is the significance of the snippet below? Showing the relevant properties within the Context object?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markzegarelli yes, that is correct. The idea was to demonstrate an example of implementing the required parameters. Do you think there is a better or clearer approach? I would certainly be open to any suggestions to make sure this is clear.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@James9446 Cool, makes sense. I think it will be helpful to add a sentence that explains which props the reader should notice. For example: "Notice the in the example of a a Product Added event below".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great advice thanks! I'll make that update now.

markzegarelli and others added 2 commits February 10, 2021 09:52
Added clarification for the Implementing Server Event Parameter Requirements section
@markzegarelli markzegarelli merged commit 544f3d3 into master Feb 10, 2021
@markzegarelli markzegarelli deleted the James9446-update-fb-conversions-api branch February 10, 2021 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants