-
Notifications
You must be signed in to change notification settings - Fork 376
Update Podsights destination support email [SECOPS-15401] #7711
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,37 +3,35 @@ rewrite: true | |
title: Podsights Destination | ||
id: 5d25eddde3ff660001b3adda | ||
--- | ||
[Podsights](https://podsights.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} measures the effectiveness of podcast advertising. Through integrations with podcast hosting providers, matches downloads with on-site actions, providing advertisers household-level attribution. | ||
|
||
This destination is maintained by Podsights. For any issues with the destination, [contact the Podsights Support team](mailto:[email protected]). | ||
|
||
|
||
## Getting Started | ||
[Podsights](https://podsights.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} measures the effectiveness of podcast advertising. Through integrations with podcast hosting providers, Podsights matches podcast downloads with on-site actions to provide household-level attribution. | ||
|
||
This destination is maintained by Podsights. For any issues with the destination, [contact the Podsights/Spotify support team](https://adshelp.spotify.com/HelpCenter/s/contactsupport?language=en_US){:target="_blank”}. | ||
|
||
|
||
## Getting started | ||
|
||
1. From the Segment web app, click **Catalog**. | ||
2. Search for "Podsights" in the Catalog, select it, and choose which of your sources to connect the destination to. | ||
3. Visit your [Podsights dashboard](https://analytics.podsights.com){:target="_blank"} and navigate to Manage > Pixels. Copy your Pixel ID which will be your Segment "API Key". | ||
4. Drop the Pixel ID in the "API Key" field in your Segment Settings UI. | ||
|
||
2. Search for "Podsights", select it, and choose the source you'd like to connect. | ||
3. Visit your [Podsights dashboard](https://analytics.podsights.com){:target="_blank"}, go to **Manage > Pixels**, then copy your Pixel ID. This is your Segment API Key. | ||
4. Paste the Pixel ID into the **API Key** field in your Segment destination settings. | ||
|
||
Once you start sending data to the Podsights' Destination it will take up to 20 minutes to appear in the Podsights pixel debugger. | ||
|
||
## Page | ||
|
||
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like: | ||
If you're not familiar with the Segment Spec, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like: | ||
|
||
```js | ||
analytics.page() | ||
``` | ||
|
||
Page calls will be sent to Podsights as a `view` event. | ||
Segment sends Page events to Podsights as `view` events. | ||
|
||
Podsights is an attribution platform, and as such, we need more context about the visitor than just a User ID. Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podsights requires certain context fields and properties for page calls. Below is an example of a raw JSON payload that contains the minimum requirements. | ||
Podsights needs additional context for attribution, including certain fields inside the `context` and `properties` objects. Analytics.js [automatically collects these fields](/docs/connections/spec/common/#context-fields-automatically-collected), but you must provide them manually when sending events server-side. | ||
|
||
```js | ||
Here’s the minimum required structure for a Page call: | ||
|
||
```json | ||
{ | ||
"type": "page", | ||
"context": { | ||
|
@@ -49,14 +47,14 @@ Podsights is an attribution platform, and as such, we need more context about th | |
} | ||
``` | ||
|
||
For page events Podsights requires a `context` object that contains a `userAgent` and an `ip` field and a `properties` object that contains a `referrer` and a `url` field. | ||
As you can see in the page event's raw JSON payload above. | ||
For page events, Podsights requires a `context` object that contains a `userAgent` and an `ip` field and a `properties` object that contains a `referrer` and a `url` field. | ||
As you can see in the page event's raw JSON payload. | ||
|
||
The `context` and `properties` object are required, along with the fields in them. If you're using Segment server-side you must send these attributes. Otherwise Podsights will return a `400 HTTP Error`. | ||
If any of these required fields are missing (especially if you're sending events server-side), Podsights will return a `400` HTTP error. | ||
|
||
## Track | ||
|
||
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: | ||
If you're not familiar with the Segment Spec, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call would look like: | ||
|
||
```js | ||
analytics.track('Order Completed', { | ||
|
@@ -67,19 +65,22 @@ analytics.track('Order Completed', { | |
}); | ||
``` | ||
|
||
Track calls will be mapped to Podsights events. Podsights' support the following from the Segment Spec: | ||
|
||
Track calls will be mapped to Podsights events. Podsights supports the following from the Segment Spec: | ||
|
||
* [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `lead` | ||
* [Product Viewed](/docs/connections/spec/ecommerce/v2/#product-viewed) as `product` | ||
* [Product Added](/docs/connections/spec/ecommerce/v2/#product-added) as `addtocart` | ||
* [Checkout Started](/docs/connections/spec/ecommerce/v2/#checkout-started) as `checkout` | ||
* [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase` | ||
|
||
For track events Podsights requires a `context` object that contains a `userAgent` and an `ip` Podsights also requires a `page` object that contains a `referrer` and a `url` field. | ||
Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podsights requires certain context fields for track calls. Below is an example of a raw JSON payload that contains the minimum requirements. | ||
Track calls must include: | ||
|
||
```js | ||
- a `context` object with `userAgent` and `ip` | ||
- a `context.page` object with `referrer` and `url` | ||
|
||
These fields are required whether they're sent through Analytics.js or server-side. Here’s a minimum working example: | ||
|
||
```json | ||
{ | ||
"type": "track", | ||
"context": { | ||
|
@@ -97,7 +98,7 @@ Analytics.js [automatically collects context fields](/docs/connections/spec/comm | |
} | ||
``` | ||
|
||
The `context` and `page` object are required, along with the fields in them. If you're using Segment server-side you must send these attributes. Otherwise Podsights will return a `400 HTTP Error`. | ||
If you're using Segment server-side, you must send these attributes. Otherwise, Podsights will return a `400` HTTP error. | ||
|
||
## Server | ||
Podsights does not support server-side events out of the box, but you can send server-side events if you follow the requirements of page and track events outlined in the sections for each call. | ||
Podsights doesn’t support server-side events by default. However, you can send server-side events as long as you include all the required context and page fields described in the Page and Track sections on this page. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.