Skip to content

Commit bd6f794

Browse files
committed
feat(podscribe) destination docs
1 parent 68f7a1f commit bd6f794

File tree

1 file changed

+86
-0
lines changed
  • src/connections/destinations/catalog/actions-podscribe

1 file changed

+86
-0
lines changed
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Podscribe Destination
3+
---
4+
5+
[Podscribe](https://podscribe.com/){: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.
6+
7+
{% include content/beta-note.md %}
8+
9+
## Getting Started
10+
11+
1. From the Segment web app, click **Catalog**.
12+
2. Search for "Podscribe" in the Catalog, select it, and choose which of your sources to connect the destination to.
13+
14+
Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page.
15+
16+
## Page
17+
18+
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:
19+
20+
```js
21+
analytics.page();
22+
```
23+
24+
Page calls will be sent to Podscribe as a `view` event.
25+
26+
Podscribe 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). Podscribe requires certain context fields and properties for page calls. Below is an example of a raw JSON payload that contains the minimum requirements.
27+
28+
```js
29+
{
30+
"type": "page",
31+
"context": {
32+
"ip": "111.111.111.111",
33+
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36"
34+
},
35+
"properties": {
36+
"referrer": "",
37+
"url": "https://url.com"
38+
},
39+
"timestamp": "2023-11-05T01:00:00.000Z",
40+
"userId": "3212"
41+
}
42+
```
43+
44+
For page events Podscribe requires a `context` object that contains a `userAgent` and an `ip` field and a `properties` object that contains a `referrer` and a `url` field.
45+
As you can see in the page event's raw JSON payload above.
46+
47+
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.
48+
49+
## Track
50+
51+
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:
52+
53+
```js
54+
analytics.track("Order Completed", {
55+
order_id: "50314b8e9bcf000000000000",
56+
total: 27.5,
57+
coupon: "hasbros",
58+
currency: "USD",
59+
});
60+
```
61+
62+
Track calls will be mapped to Podscribe events. Podscribe support the following from the Segment Spec:
63+
64+
- [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `signup`
65+
- [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase`
66+
67+
For track events Podscribe requires a `context` object that contains a `userAgent` and an `ip` Podscribe also requires a `page` object that contains a `referrer` and a `url` field.
68+
Analytics.js [automatically collects context fields](/docs/connections/spec/common/#context-fields-automatically-collected). Podscribe requires certain context fields for track calls. Below is an example of a raw JSON payload that contains the minimum requirements.
69+
70+
```js
71+
{
72+
"type": "track",
73+
"context": {
74+
"ip": "1.2.3.4",
75+
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko Chrome/118.0.0.0 Safari/537.36"
76+
"page": {
77+
"url": "https://url.com",
78+
"referrer": ""
79+
}
80+
},
81+
"event": "Test Event Name",
82+
"userId": "test-user-xip99",
83+
"timestamp": "2023-11-05T01:00:00.000Z",
84+
"properties": {}
85+
}
86+
```

0 commit comments

Comments
 (0)