From cb9819e223a647b03072b9373b5cbf3f42867be8 Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Mon, 10 Jun 2024 13:59:12 +0300 Subject: [PATCH 1/9] [PR-22076] [Placements] Update integration lib to specify div --- .../campaigns/campaign_placements/post_purchase.rst | 12 ++++++++++++ source/partials/campaign_placements_description.rst | 4 ++++ 2 files changed, 16 insertions(+) diff --git a/source/campaigns/campaign_placements/post_purchase.rst b/source/campaigns/campaign_placements/post_purchase.rst index fa9d4b347..89d27a585 100644 --- a/source/campaigns/campaign_placements/post_purchase.rst +++ b/source/campaigns/campaign_placements/post_purchase.rst @@ -35,6 +35,10 @@ Shopify Platform #. **Configure Campaign and Placement.** Create a new Campaign with Post Purchase type of Placement, configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. + |br| + Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. + |br| + In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -51,6 +55,10 @@ Magento Platform #. **Configure Campaign and Placement.** Create a new Campaign with Post Purchase type of Placement, configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. + |br| + Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. + |br| + In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -72,6 +80,10 @@ Custom Platform It will be automatically attached to its Post Purchase Placement that triggers a Campaign on the order confirmation page. |br| + Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. + |br| + In the placement settings, you can now change the `div` id value. It can be customized to any value you type. + |br| If you need to change or reconfigure which Campaigns are shown on which URLs then visit `https://admin.talkable.com/sites//placements` page. diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index 83dd9540e..e95c12934 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -41,6 +41,10 @@ The criteria can be defined using one of the following operators: .. note:: Custom Property Criteria require integration version 5.1.4 or higher to work. +**Container name changes**. +It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` name in the placement setup, ensuring flexibility and customization according to your needs. By default, the `div` name is `talkable-offer` for Standalone, Standalone Dashboard, Floating Widget; `talkable-gleam-reward` for Gleam; `talkable-claim-by-name` for Claim By Name; `talkable-email-capture-offer` for Email Capture; `talkable-loyalty` for Loyalty Dashboard and Loyalty Widget, but it can be changed to any value you type. +For Post Purchase Placement, the container name will generate automatically based on the site slug. + |hr| .. raw:: html From 45071cfc1b951e86b4243caa2d36c9daadff134d Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest <79131278+bohdan-perekhrest@users.noreply.github.com> Date: Sun, 16 Jun 2024 11:25:39 +0300 Subject: [PATCH 2/9] Update source/partials/campaign_placements_description.rst Co-authored-by: Bohdan Zhuravel --- source/partials/campaign_placements_description.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index e95c12934..3cbe90d89 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -43,7 +43,7 @@ The criteria can be defined using one of the following operators: **Container name changes**. It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` name in the placement setup, ensuring flexibility and customization according to your needs. By default, the `div` name is `talkable-offer` for Standalone, Standalone Dashboard, Floating Widget; `talkable-gleam-reward` for Gleam; `talkable-claim-by-name` for Claim By Name; `talkable-email-capture-offer` for Email Capture; `talkable-loyalty` for Loyalty Dashboard and Loyalty Widget, but it can be changed to any value you type. -For Post Purchase Placement, the container name will generate automatically based on the site slug. +For Post Purchase Placement, the container name is generated automatically based on the site slug. |hr| From d23ff90d08f36e0eb7217ee8209b8339a528fc1a Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Thu, 20 Jun 2024 13:50:56 +0300 Subject: [PATCH 3/9] CR remarks --- .../campaigns/campaign_placements/post_purchase.rst | 9 +++------ source/partials/campaign_placements_description.rst | 11 +++++++++-- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/source/campaigns/campaign_placements/post_purchase.rst b/source/campaigns/campaign_placements/post_purchase.rst index 89d27a585..042537f7a 100644 --- a/source/campaigns/campaign_placements/post_purchase.rst +++ b/source/campaigns/campaign_placements/post_purchase.rst @@ -25,6 +25,9 @@ Integration instructions Instructions slightly vary based on your site platform. +#. **Talkable Container DIV.** By default post purchase campaign will have `talkable-post-purchase` id of container. If + you want to update it you can do it in admin panel. + Shopify Platform ---------------- @@ -36,8 +39,6 @@ Shopify Platform configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. |br| - Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. - |br| In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -56,8 +57,6 @@ Magento Platform configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. |br| - Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. - |br| In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -80,8 +79,6 @@ Custom Platform It will be automatically attached to its Post Purchase Placement that triggers a Campaign on the order confirmation page. |br| - Each Post Purchase placement will now have a unique `div` id. Ensure that your updated view code includes this unique `div` id. - |br| In the placement settings, you can now change the `div` id value. It can be customized to any value you type. |br| If you need to change or reconfigure which Campaigns are shown on which URLs then visit diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index 3cbe90d89..8e5c3cc53 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -42,8 +42,15 @@ The criteria can be defined using one of the following operators: Custom Property Criteria require integration version 5.1.4 or higher to work. **Container name changes**. -It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` name in the placement setup, ensuring flexibility and customization according to your needs. By default, the `div` name is `talkable-offer` for Standalone, Standalone Dashboard, Floating Widget; `talkable-gleam-reward` for Gleam; `talkable-claim-by-name` for Claim By Name; `talkable-email-capture-offer` for Email Capture; `talkable-loyalty` for Loyalty Dashboard and Loyalty Widget, but it can be changed to any value you type. -For Post Purchase Placement, the container name is generated automatically based on the site slug. +It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` id in the placement setup, ensuring flexibility and customization according to your needs. +By default, the `div` id is: +* `talkable-offer` for Standalone, Standalone Dashboard, Floating Widget; +* `talkable-post-purchase` for Post Purchase; +* `talkable-post-event` for Post Event; +* `talkable-gleam-reward` for Gleam; +* `talkable-claim-by-name` for Claim By Name; +* `talkable-email-capture-offer` for Email Capture; +* `talkable-loyalty` for Loyalty Dashboard and Loyalty Widget. |hr| From b85d135f34b4c3dc5f106265abd59129e5c22a1d Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Sat, 11 Jan 2025 13:59:54 +0200 Subject: [PATCH 4/9] update docs --- .../campaign_placements/post_purchase.rst | 9 --------- .../campaign_placements_description.rst | 18 ++++++++++-------- 2 files changed, 10 insertions(+), 17 deletions(-) diff --git a/source/campaigns/campaign_placements/post_purchase.rst b/source/campaigns/campaign_placements/post_purchase.rst index 042537f7a..fa9d4b347 100644 --- a/source/campaigns/campaign_placements/post_purchase.rst +++ b/source/campaigns/campaign_placements/post_purchase.rst @@ -25,9 +25,6 @@ Integration instructions Instructions slightly vary based on your site platform. -#. **Talkable Container DIV.** By default post purchase campaign will have `talkable-post-purchase` id of container. If - you want to update it you can do it in admin panel. - Shopify Platform ---------------- @@ -38,8 +35,6 @@ Shopify Platform #. **Configure Campaign and Placement.** Create a new Campaign with Post Purchase type of Placement, configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. - |br| - In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -56,8 +51,6 @@ Magento Platform #. **Configure Campaign and Placement.** Create a new Campaign with Post Purchase type of Placement, configure it and launch. It will be automatically attached to the Post Purchase Placement and so, show up to your customers every time they purchase successfully on your site. - |br| - In the placement settings, you can now change the `div` id value. It can be customized to any value you type. | @@ -79,8 +72,6 @@ Custom Platform It will be automatically attached to its Post Purchase Placement that triggers a Campaign on the order confirmation page. |br| - In the placement settings, you can now change the `div` id value. It can be customized to any value you type. - |br| If you need to change or reconfigure which Campaigns are shown on which URLs then visit `https://admin.talkable.com/sites//placements` page. diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index 8e5c3cc53..b50961880 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -42,15 +42,17 @@ The criteria can be defined using one of the following operators: Custom Property Criteria require integration version 5.1.4 or higher to work. **Container name changes**. -It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` id in the placement setup, ensuring flexibility and customization according to your needs. +It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` id for each event category, ensuring flexibility and customization according to your needs. By default, the `div` id is: -* `talkable-offer` for Standalone, Standalone Dashboard, Floating Widget; -* `talkable-post-purchase` for Post Purchase; -* `talkable-post-event` for Post Event; -* `talkable-gleam-reward` for Gleam; -* `talkable-claim-by-name` for Claim By Name; -* `talkable-email-capture-offer` for Email Capture; -* `talkable-loyalty` for Loyalty Dashboard and Loyalty Widget. + +* `talkable-offer` for `affiliate_member` event category which includes: Standalone, Standalone Dashboard, Floating Widget, Gleam; +* `talkable-post-purchase` for `purchase` event category which includes: Post Purchase; +* `talkable-claim-by-name` for `claim_by_name_popup` event category which includes: Claim By Name; +* `talkable-email-capture-offer` for `email_capture_popup` event category which includes: Conversion Popup; +* `talkable-loyalty` for `loyalty_dashboard` and `loyalty_widget` event categories which include: Loyalty Dashboard and Loyalty Widget. + +.. note:: + Container name changes require integration version 5.3.0 or higher to work. |hr| From 4ca8e58caa8eb457f50212161a49adcb70b30cec Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Mon, 13 Jan 2025 18:14:56 +0200 Subject: [PATCH 5/9] Updates --- source/partials/campaign_placements_description.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index b50961880..2a02d3cf3 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -41,8 +41,10 @@ The criteria can be defined using one of the following operators: .. note:: Custom Property Criteria require integration version 5.1.4 or higher to work. -**Container name changes**. -It is possible to update the container name from the admin panel in placements settings. It allows you to edit the `div` id for each event category, ensuring flexibility and customization according to your needs. +**Container name**. +It is possible to update the container name from the admin panel in placements settings. +It allows you to edit the `div` id for each event category, ensuring flexibility and customization according to your needs. + By default, the `div` id is: * `talkable-offer` for `affiliate_member` event category which includes: Standalone, Standalone Dashboard, Floating Widget, Gleam; @@ -52,7 +54,7 @@ By default, the `div` id is: * `talkable-loyalty` for `loyalty_dashboard` and `loyalty_widget` event categories which include: Loyalty Dashboard and Loyalty Widget. .. note:: - Container name changes require integration version 5.3.0 or higher to work. + Container name changes require integration version 5.3.0 or higher to work. |hr| From d52d0abb430eed939133c310359d0447f1306f19 Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Wed, 29 Jan 2025 17:12:52 +0200 Subject: [PATCH 6/9] [PR-23808] Remarks --- source/integration/custom/integration_components.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/integration/custom/integration_components.rst b/source/integration/custom/integration_components.rst index 6e62e8e49..f8aa916bd 100644 --- a/source/integration/custom/integration_components.rst +++ b/source/integration/custom/integration_components.rst @@ -46,11 +46,15 @@ Talkable is composed of the following components: Create an HTML page (URL path /share) with your standard site header and footer. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. + Talkable Container DIV can be changed at Placement Edit page(Do not forget to change DIV in your integration after + updating Container DIV) 5. :ref:`Referral Dashboard (my account) `. Similar to the advocate landing page, create an HTML page that’s linked to from a menu in user accounts. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. + Talkable Container DIV can be changed at Placement Edit page(Do not forget to change DIV in your integration after + updating Container DIV) |hr| From cb3164f3efc87b948ebd622aa3b292b1c9b1a1a3 Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Wed, 29 Jan 2025 18:53:32 +0200 Subject: [PATCH 7/9] CR remarks --- source/integration/custom/integration_components.rst | 12 ++++++++---- source/partials/campaign_placements_description.rst | 6 +++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/source/integration/custom/integration_components.rst b/source/integration/custom/integration_components.rst index f8aa916bd..bd17a078e 100644 --- a/source/integration/custom/integration_components.rst +++ b/source/integration/custom/integration_components.rst @@ -46,15 +46,19 @@ Talkable is composed of the following components: Create an HTML page (URL path /share) with your standard site header and footer. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. - Talkable Container DIV can be changed at Placement Edit page(Do not forget to change DIV in your integration after - updating Container DIV) + +.. note:: + The Talkable Container DIV can be changed upon request to the Talkable team. + The current DIV id value for each Event Category can be found on the Placements page. 5. :ref:`Referral Dashboard (my account) `. Similar to the advocate landing page, create an HTML page that’s linked to from a menu in user accounts. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. - Talkable Container DIV can be changed at Placement Edit page(Do not forget to change DIV in your integration after - updating Container DIV) + +.. note:: + The Talkable Container DIV can be changed upon request to the Talkable team. + The current DIV id value for each Event Category can be found on the Placements page. |hr| diff --git a/source/partials/campaign_placements_description.rst b/source/partials/campaign_placements_description.rst index 2a02d3cf3..415517a7f 100644 --- a/source/partials/campaign_placements_description.rst +++ b/source/partials/campaign_placements_description.rst @@ -42,10 +42,10 @@ The criteria can be defined using one of the following operators: Custom Property Criteria require integration version 5.1.4 or higher to work. **Container name**. -It is possible to update the container name from the admin panel in placements settings. -It allows you to edit the `div` id for each event category, ensuring flexibility and customization according to your needs. +It is possible to update the container name by requesting assistance from the Talkable team. +The current DIV id value for each Event Category can be found on the Placements page. -By default, the `div` id is: +By default, the DIV id is: * `talkable-offer` for `affiliate_member` event category which includes: Standalone, Standalone Dashboard, Floating Widget, Gleam; * `talkable-post-purchase` for `purchase` event category which includes: Post Purchase; From cfa1d2b39319fa33be7244255ac6409dd2594f7e Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Wed, 29 Jan 2025 19:12:08 +0200 Subject: [PATCH 8/9] Move note blocks under actual description --- .../custom/integration_components.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/source/integration/custom/integration_components.rst b/source/integration/custom/integration_components.rst index bd17a078e..0ec046dab 100644 --- a/source/integration/custom/integration_components.rst +++ b/source/integration/custom/integration_components.rst @@ -47,19 +47,11 @@ Talkable is composed of the following components: Create an HTML page (URL path /share) with your standard site header and footer. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. -.. note:: - The Talkable Container DIV can be changed upon request to the Talkable team. - The current DIV id value for each Event Category can be found on the Placements page. - 5. :ref:`Referral Dashboard (my account) `. Similar to the advocate landing page, create an HTML page that’s linked to from a menu in user accounts. Add the Talkable Container DIV in the body. This tells Talkable where to inject content. -.. note:: - The Talkable Container DIV can be changed upon request to the Talkable team. - The current DIV id value for each Event Category can be found on the Placements page. - |hr| .. _integration/custom/integration_components/initialization_script: @@ -171,6 +163,10 @@ Advocate Landing Page Create a new HTML page with URL path (`www.your-site.com/share`) and add the Talkable Container DIV in the body of the page between your standard site header and footer: +.. note:: + The Talkable Container DIV can be changed upon request to the Talkable team. + The current DIV id value for each Event Category can be found on the Placements page. + .. code-block:: html
@@ -204,6 +200,10 @@ Similar to the Advocate Landing Page, create a new HTML page with URL path (`www.your-site.com/referrals`) and add the Talkable Container DIV in the body of the page: +.. note:: + The Talkable Container DIV can be changed upon request to the Talkable team. + The current DIV id value for each Event Category can be found on the Placements page. + .. code-block:: html
From 63dd123cb32aff0e6d09afd5acf0cfd35f875c4b Mon Sep 17 00:00:00 2001 From: Bohdan Perekhrest Date: Thu, 30 Jan 2025 14:25:34 +0200 Subject: [PATCH 9/9] Bug fixes --- source/integration/custom/integration_components.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/integration/custom/integration_components.rst b/source/integration/custom/integration_components.rst index 0ec046dab..f066c73ac 100644 --- a/source/integration/custom/integration_components.rst +++ b/source/integration/custom/integration_components.rst @@ -164,7 +164,7 @@ Create a new HTML page with URL path (`www.your-site.com/share`) and add the Tal in the body of the page between your standard site header and footer: .. note:: - The Talkable Container DIV can be changed upon request to the Talkable team. + The Talkable Container DIV id can be changed upon request to the Talkable team. The current DIV id value for each Event Category can be found on the Placements page. .. code-block:: html @@ -201,7 +201,7 @@ path (`www.your-site.com/referrals`) and add the Talkable Container DIV in the body of the page: .. note:: - The Talkable Container DIV can be changed upon request to the Talkable team. + The Talkable Container DIV id can be changed upon request to the Talkable team. The current DIV id value for each Event Category can be found on the Placements page. .. code-block:: html