diff --git a/amperity_operator/source/campaign_amazon_ads.rst b/amperity_operator/source/campaign_amazon_ads.rst index 35b789992..75b605896 100755 --- a/amperity_operator/source/campaign_amazon_ads.rst +++ b/amperity_operator/source/campaign_amazon_ads.rst @@ -237,8 +237,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_criteo.rst b/amperity_operator/source/campaign_criteo.rst index 4a8a1e4c7..542cda3f4 100755 --- a/amperity_operator/source/campaign_criteo.rst +++ b/amperity_operator/source/campaign_criteo.rst @@ -216,8 +216,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_dv360.rst b/amperity_operator/source/campaign_dv360.rst index 049111f3a..fd10b017a 100755 --- a/amperity_operator/source/campaign_dv360.rst +++ b/amperity_operator/source/campaign_dv360.rst @@ -213,8 +213,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_google_ads.rst b/amperity_operator/source/campaign_google_ads.rst index d1cd73216..ba05f9435 100755 --- a/amperity_operator/source/campaign_google_ads.rst +++ b/amperity_operator/source/campaign_google_ads.rst @@ -180,8 +180,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_google_customer_match.rst b/amperity_operator/source/campaign_google_customer_match.rst index 2868b08ce..d02aaf36f 100755 --- a/amperity_operator/source/campaign_google_customer_match.rst +++ b/amperity_operator/source/campaign_google_customer_match.rst @@ -144,8 +144,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_hubspot.rst b/amperity_operator/source/campaign_hubspot.rst index a0cebc072..e8a8d9281 100755 --- a/amperity_operator/source/campaign_hubspot.rst +++ b/amperity_operator/source/campaign_hubspot.rst @@ -141,8 +141,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_linkedin_dmp.rst b/amperity_operator/source/campaign_linkedin_dmp.rst index c4b8f7ebe..2d5421e5a 100755 --- a/amperity_operator/source/campaign_linkedin_dmp.rst +++ b/amperity_operator/source/campaign_linkedin_dmp.rst @@ -168,8 +168,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_listrak_sms.rst b/amperity_operator/source/campaign_listrak_sms.rst index 1c0a8abe0..8c7f3ef12 100755 --- a/amperity_operator/source/campaign_listrak_sms.rst +++ b/amperity_operator/source/campaign_listrak_sms.rst @@ -2,7 +2,7 @@ .. |destination-name| replace:: Listrak SMS -.. |plugin-name| replace:: "Listrak SMS -- List Management" +.. |plugin-name| replace:: "Listrak SMS--List Management" .. |credential-type| replace:: "listrak-sms" .. |required-credentials| replace:: "refresh token" .. |audience-primary-key| replace:: "phone" diff --git a/amperity_operator/source/campaign_meta_ads_manager.rst b/amperity_operator/source/campaign_meta_ads_manager.rst index 94506e85e..f4954c1e1 100755 --- a/amperity_operator/source/campaign_meta_ads_manager.rst +++ b/amperity_operator/source/campaign_meta_ads_manager.rst @@ -186,8 +186,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_microsoft_ads.rst b/amperity_operator/source/campaign_microsoft_ads.rst index 6eba4eba1..caeb8242a 100755 --- a/amperity_operator/source/campaign_microsoft_ads.rst +++ b/amperity_operator/source/campaign_microsoft_ads.rst @@ -159,8 +159,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_pinterest.rst b/amperity_operator/source/campaign_pinterest.rst index 186ecf448..a13093d48 100755 --- a/amperity_operator/source/campaign_pinterest.rst +++ b/amperity_operator/source/campaign_pinterest.rst @@ -183,8 +183,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_snapchat.rst b/amperity_operator/source/campaign_snapchat.rst index 70634e9e9..e708e29f8 100755 --- a/amperity_operator/source/campaign_snapchat.rst +++ b/amperity_operator/source/campaign_snapchat.rst @@ -141,8 +141,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/campaign_tiktok_ads.rst b/amperity_operator/source/campaign_tiktok_ads.rst index 2709135e2..f71cf6d6f 100755 --- a/amperity_operator/source/campaign_tiktok_ads.rst +++ b/amperity_operator/source/campaign_tiktok_ads.rst @@ -170,8 +170,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/destination_amazon_ads.rst b/amperity_operator/source/destination_amazon_ads.rst index 362337f4b..d01dfca07 100755 --- a/amperity_operator/source/destination_amazon_ads.rst +++ b/amperity_operator/source/destination_amazon_ads.rst @@ -235,8 +235,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/destination_criteo.rst b/amperity_operator/source/destination_criteo.rst index a0e10de44..100dc9376 100755 --- a/amperity_operator/source/destination_criteo.rst +++ b/amperity_operator/source/destination_criteo.rst @@ -215,8 +215,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/destination_dv360.rst b/amperity_operator/source/destination_dv360.rst index a4f36e62e..8ec4efcb8 100755 --- a/amperity_operator/source/destination_dv360.rst +++ b/amperity_operator/source/destination_dv360.rst @@ -213,8 +213,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/destination_hubspot.rst b/amperity_operator/source/destination_hubspot.rst index 675a5ade4..01d4e58cf 100755 --- a/amperity_operator/source/destination_hubspot.rst +++ b/amperity_operator/source/destination_hubspot.rst @@ -141,8 +141,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/destination_listrak_sms.rst b/amperity_operator/source/destination_listrak_sms.rst index 47c7edd9e..9bc9fb5fd 100755 --- a/amperity_operator/source/destination_listrak_sms.rst +++ b/amperity_operator/source/destination_listrak_sms.rst @@ -2,7 +2,7 @@ .. |destination-name| replace:: Listrak SMS -.. |plugin-name| replace:: "Listrak SMS -- List Management" +.. |plugin-name| replace:: "Listrak SMS--List Management" .. |credential-type| replace:: "listrak-sms" .. |required-credentials| replace:: "refresh token" .. |audience-primary-key| replace:: "phone" diff --git a/amperity_operator/source/destination_pinterest.rst b/amperity_operator/source/destination_pinterest.rst index d4608827d..9c5f690cf 100755 --- a/amperity_operator/source/destination_pinterest.rst +++ b/amperity_operator/source/destination_pinterest.rst @@ -188,8 +188,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/events_meta_ads_manager.rst b/amperity_operator/source/events_meta_ads_manager.rst index b9fb075ec..6bd37d26e 100755 --- a/amperity_operator/source/events_meta_ads_manager.rst +++ b/amperity_operator/source/events_meta_ads_manager.rst @@ -138,8 +138,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_operator/source/events_tiktok_ads.rst b/amperity_operator/source/events_tiktok_ads.rst index bdc3601ea..be2cf32e1 100755 --- a/amperity_operator/source/events_tiktok_ads.rst +++ b/amperity_operator/source/events_tiktok_ads.rst @@ -161,8 +161,8 @@ Configure credentials :align: center :class: no-scaled-link - .. include:: ../../shared/credentials_settings.rst - :start-after: .. credential-steps-select-type-start - :end-before: .. credential-steps-select-type-end + :start-after: .. credential-steps-select-type-external-start + :end-before: .. credential-steps-select-type-external-end * - .. image:: ../../images/steps-03.png :width: 60 px diff --git a/amperity_reference/source/credentials.rst b/amperity_reference/source/credentials.rst index b6ea8f6a2..6c8dae61e 100755 --- a/amperity_reference/source/credentials.rst +++ b/amperity_reference/source/credentials.rst @@ -3,6 +3,7 @@ .. |destination-name| replace:: the name of application for which credentials are configired .. |credential-type| replace:: selected +.. |plugin-name| replace:: a plugin .. |where-send| replace:: the application for which credentials are being configured .. |sftp-hostname| replace:: "sftp.acme.com" diff --git a/shared/credentials_settings.rst b/shared/credentials_settings.rst index 9b7bec9f7..e690ccaa3 100755 --- a/shared/credentials_settings.rst +++ b/shared/credentials_settings.rst @@ -50,11 +50,11 @@ From the **Settings** page, select the **Credentials** tab, and then click the * .. credential-steps-select-type-start -In the **Credentials settings** dialog box, do the following: +In the **Create credentials** dialog box, do the following: -From the **Plugin** dropdown, select |destination-name|. +#. From the **Plugin** dropdown, select |plugin-name|. -Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination. +#. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination. .. credential-steps-select-type-end @@ -66,14 +66,33 @@ Notes: When a source or destination supports more than one credential type, use .. credential-steps-select-type-multiple-start -In the **Credentials settings** dialog box, do the following: +In the **Create credentials** dialog box, do the following: -From the **Plugin** dropdown, select |destination-name|. +#. From the **Plugin** dropdown, select |plugin-name|. -Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination. +#. Assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination. .. credential-steps-select-type-multiple-end +.. vale off + +Notes: The "external" steps apply only to Amazon Ads, Criteo Audience API, Criteo Retail Audience API, DV360, Facebook, Google Ads, Google Analytics, Google Customer Match, Google Enhanced Conversions, Hubspot, LinkedIn DMP, Meta Ads Offline Events, Microsoft Ads, Pinterest, Reddit Ads, Snapchat, TikTok Ads, and TikTok Ads Offline Events. + +.. vale on + +.. credential-steps-select-type-external-start + +In the **Create credentials** dialog box, do the following: + +#. From the **Plugin** dropdown, select |plugin-name|. + +#. Click **Generate authorzation URL**, and then complete the external authorization steps shown for |destination-name|. + +#. After the external authorization steps are completed, assign the credential a name and description that ensures other users of Amperity can recognize when to use this destination. + +.. credential-steps-select-type-external-end + + **Step 03** .. vale off