From bd6f79412abba4496a22ed5250b32d3eb97f957f Mon Sep 17 00:00:00 2001 From: Petr Ryabinin Date: Sun, 5 Nov 2023 20:41:39 +0100 Subject: [PATCH 1/6] feat(podscribe) destination docs --- .../catalog/actions-podscribe/index.md | 86 +++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 src/connections/destinations/catalog/actions-podscribe/index.md diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md new file mode 100644 index 0000000000..a62d7c879f --- /dev/null +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -0,0 +1,86 @@ +--- +title: Podscribe Destination +--- + +[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. + +{% include content/beta-note.md %} + +## Getting Started + +1. From the Segment web app, click **Catalog**. +2. Search for "Podscribe" in the Catalog, select it, and choose which of your sources to connect the destination to. + +Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page. + +## 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: + +```js +analytics.page(); +``` + +Page calls will be sent to Podscribe as a `view` event. + +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. + +```js +{ + "type": "page", + "context": { + "ip": "111.111.111.111", + "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" + }, + "properties": { + "referrer": "", + "url": "https://url.com" + }, + "timestamp": "2023-11-05T01:00:00.000Z", + "userId": "3212" +} +``` + +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. +As you can see in the page event's raw JSON payload above. + +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. + +## 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: + +```js +analytics.track("Order Completed", { + order_id: "50314b8e9bcf000000000000", + total: 27.5, + coupon: "hasbros", + currency: "USD", +}); +``` + +Track calls will be mapped to Podscribe events. Podscribe support the following from the Segment Spec: + +- [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `signup` +- [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase` + +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. +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. + +```js +{ + "type": "track", + "context": { + "ip": "1.2.3.4", + "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" + "page": { + "url": "https://url.com", + "referrer": "" + } + }, + "event": "Test Event Name", + "userId": "test-user-xip99", + "timestamp": "2023-11-05T01:00:00.000Z", + "properties": {} +} +``` From 8152de0cab46c811e41b2b360d106eb56e4dd10c Mon Sep 17 00:00:00 2001 From: rchinn-segment Date: Mon, 13 Nov 2023 12:10:33 -0800 Subject: [PATCH 2/6] Creating an editable PR --- .../destinations/catalog/actions-podscribe/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md index a62d7c879f..6162224bfc 100644 --- a/src/connections/destinations/catalog/actions-podscribe/index.md +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -6,7 +6,7 @@ title: Podscribe Destination {% include content/beta-note.md %} -## Getting Started +## Getting started 1. From the Segment web app, click **Catalog**. 2. Search for "Podscribe" in the Catalog, select it, and choose which of your sources to connect the destination to. From 539dae53342fdf667aa05d9ae4eb0ba423245b1a Mon Sep 17 00:00:00 2001 From: rchinn-segment Date: Mon, 13 Nov 2023 16:47:53 -0800 Subject: [PATCH 3/6] a few initial edits --- .../actions-podscribe/{index.md => index.md} | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) rename src/connections/destinations/catalog/actions-podscribe/{index.md => index.md} (67%) diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md similarity index 67% rename from src/connections/destinations/catalog/actions-podscribe/index.md rename to src/connections/destinations/catalog/actions-podscribe/index.md index 6162224bfc..145a93bdd5 100644 --- a/src/connections/destinations/catalog/actions-podscribe/index.md +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -8,8 +8,8 @@ title: Podscribe Destination ## Getting started -1. From the Segment web app, click **Catalog**. -2. Search for "Podscribe" in the Catalog, select it, and choose which of your sources to connect the destination to. +1. From the Segment web app, navigate to **Connections > Catalog**. +2. Search for "Podscribe", select it, and choose which of your sources to connect the destination to. Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page. @@ -21,9 +21,9 @@ If you're not familiar with the Segment Specs, take a look to understand what th analytics.page(); ``` -Page calls will be sent to Podscribe as a `view` event. +Page calls will be sent to Podscribe as a View event. -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. +Podscribe is an attribution platform, and as such, Podscribe needs 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. ```js { @@ -41,8 +41,11 @@ Podscribe is an attribution platform, and as such, we need more context about th } ``` -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. -As you can see in the page event's raw JSON payload above. +For Page events Podscribe requires: +- A `context` object that contains a `userAgent` and an `ip` field +- A `properties` object that contains a `referrer` and a `url` field. + +You'll see these in the Page event's raw JSON payload above. 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. @@ -59,13 +62,16 @@ analytics.track("Order Completed", { }); ``` -Track calls will be mapped to Podscribe events. Podscribe support the following from the Segment Spec: +Track calls will be mapped to Podscribe events. Podscribe supports the following from the Segment Spec: - [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) as `signup` - [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) as `purchase` -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. -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. +For Track events, Podscribe requires: +- A `context` object that contains a `userAgent` +- An `ip` Podscribe 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). Podscribe requires certain context fields for Track calls. Below is an example of a raw JSON payload that contains the minimum requirements. ```js { From d235736d5d07fe2edec1e2dcba5ff078a614d0cf Mon Sep 17 00:00:00 2001 From: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> Date: Wed, 15 Nov 2023 14:47:57 -0500 Subject: [PATCH 4/6] add frontmatter and field snippet --- .../destinations/catalog/actions-podscribe/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md index 145a93bdd5..c6c66d217e 100644 --- a/src/connections/destinations/catalog/actions-podscribe/index.md +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -1,5 +1,7 @@ --- -title: Podscribe Destination +title: Podscribe (Actions) Destination +id: 643fdecd5675b7a6780d0d67 +beta: true --- [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. @@ -13,6 +15,8 @@ title: Podscribe Destination Once you start sending data to the Podscribe's Destination it will take up to 20 minutes to appear in the Podscribe postbacks page. +{% include components/actions-fields.html %} + ## 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: From 7b2ec5b3d4ed7519e3be2b64b0ad4cc4bea0db2e Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:22:07 -0800 Subject: [PATCH 5/6] object > objects --- src/connections/destinations/catalog/actions-podscribe/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md index c6c66d217e..9ecdb596c3 100644 --- a/src/connections/destinations/catalog/actions-podscribe/index.md +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -51,7 +51,7 @@ For Page events Podscribe requires: You'll see these in the Page event's raw JSON payload above. -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. +The `context` and `properties` objects are required, along with the fields in them. If you're using Segment server-side you must send these attributes. ## Track From 1804be27c3580b69a59474f8dbefead8bd4f475e Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:22:20 -0800 Subject: [PATCH 6/6] remove period --- src/connections/destinations/catalog/actions-podscribe/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-podscribe/index.md b/src/connections/destinations/catalog/actions-podscribe/index.md index 9ecdb596c3..9e2c2ff94a 100644 --- a/src/connections/destinations/catalog/actions-podscribe/index.md +++ b/src/connections/destinations/catalog/actions-podscribe/index.md @@ -47,7 +47,7 @@ Podscribe is an attribution platform, and as such, Podscribe needs more context For Page events Podscribe requires: - A `context` object that contains a `userAgent` and an `ip` field -- A `properties` object that contains a `referrer` and a `url` field. +- A `properties` object that contains a `referrer` and a `url` field You'll see these in the Page event's raw JSON payload above.