Skip to content

fix plugin-name; add context to destinations that have external auth … #713

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.

Sign up for GitHub

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

Open
jamescott wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix plugin-name; add context to destinations that have external auth … #713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
33372a9
fix plugin-name; add context to destinations that have external auth …
jamescott Feb 27, 2026
5614d39
one more link
jamescott Feb 27, 2026
2e8502e
formatting
jamescott Feb 27, 2026
55cebef
formatting
jamescott Feb 27, 2026
58ee21b
PUNCTUATION
jamescott Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_amazon_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_criteo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_dv360.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_google_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_google_customer_match.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_hubspot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_linkedin_dmp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion amperity_operator/source/campaign_listrak_sms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_meta_ads_manager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_microsoft_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_pinterest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_snapchat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/campaign_tiktok_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/destination_amazon_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/destination_criteo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/destination_dv360.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/destination_hubspot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion amperity_operator/source/destination_listrak_sms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/destination_pinterest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/events_meta_ads_manager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions amperity_operator/source/events_tiktok_ads.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions amperity_reference/source/credentials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
31 changes: 25 additions & 6 deletions shared/credentials_settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down