Extend Consent Mode conditions for determining Ads connection status to include a check for an Ads tag as a destination of a Google Tag

[techanvil]

Feature Description

For the Consent Mode feature, we have so far implemented the check for Ads being connected to look for the presence of the Ads Conversion ID or an Ads link.

We should extend these conditions to include the additional check discussed under "when does this apply?" in the one-pager - checking for the presence of Ads tag as a destination of the connected Google Tag.

Note that we are now able to use the Tag Manager API to look up a container by tag ID, so this is now technically feasible. See the tagId parameter for the containers/lookup endpoint and the feature request where it was introduced.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• Within the Consent Mode feature, the conditions for determining whether Ads is connected should include a check for the presence of an Ads tag as a destination of the connected Google Tag.
  • The Google Tag for the connected Analytics property should be checked.
  • When Tag Manager is connected and an existing tag is found, this should be checked.
• In terms of user-visible behaviour:
  • The Setup CTA Banner should be displayed when an Ads tag is detected (while the Consent Mode enabled setting is false and the banner has not been dismissed).
  • The "Recommended" badge and the notice reading "If you have Google Ads campaigns for this site, it’s highly recommended to enable Consent mode..." on the Consent Mode section of the Settings screen should be displayed when an Ads tag is detected.

Implementation Brief

Consent Mode backend updates

• [ ] Update includes/Core/Consent_Mode/REST_Consent_Mode_Controller.php, creating a new REST endpoint recommend-consent-mode, in this endpoint:
  • [ ] First check if the Ads module is connected using the is_connected method, if this is true, return true on the endpoint immediately.
  • [ ] Next check if Analytics is connected using the is_connected method and if Ads is linked to Analytics by checking the adSenseLinked setting, return true on the endpoint immediately.
  • [ ] Finally, check if Tag Manager is connected using the is_connected method, if so:
    • [ ] Use $this->get_tagmanager_service()->accounts_containers_versions->live() to get the live version of the configured GTM tag using the accountID and internalContainerID stored in the module settings: https://github.com/google/site-kit-wp/blob/165c8bb73003e7861b3dc2eead677d034def431e/includes/Modules/Tag_Manager.php#L328-L330
    • [ ] Use array_search to check if any of the destinations in the tag[] key of the response returned for this version are of the type awct, which is an "Google Ads Conversion Tracking" tag, return true if so.
  • [ ] If none of the above conditions are met, return false.

Datastore changes

• [ ] Update assets/js/googlesitekit/datastore/site/consent-mode.js, create a new fetch store called getRecommendConsentMode to retrieve the values from the new REST endpoint above, like so: https://github.com/google/site-kit-wp/blob/165c8bb73003e7861b3dc2eead677d034def431e/assets/js/googlesitekit/datastore/site/consent-mode.js#L80-L90

Setup CTA Updates

• [ ] Update the render condition for assets/js/components/consent-mode/ConsentModeSetupCTAWidget.js to use the new getRecommendConsentMode selector to render the CTA instead of the isAdsConnected selector: https://github.com/google/site-kit-wp/blob/165c8bb73003e7861b3dc2eead677d034def431e/assets/js/components/consent-mode/ConsentModeSetupCTAWidget.js#L122-L127

Recommended Badge

• [ ] Update assets/js/components/settings/SettingsCardConsentMode.js to use the new getRecommendConsentMode selector, instead of the isAdsConnected selector to render the Recommended badge: https://github.com/google/site-kit-wp/blob/165c8bb73003e7861b3dc2eead677d034def431e/assets/js/components/settings/SettingsCardConsentMode.js#L111-L116

Test Coverage

• Create thorough tests for the new endpoint in tests/phpunit/integration/Core/Consent_Mode/REST_Consent_Mode_ControllerTest.php.

QA Brief

Changelog entry

[eugene-manuilov]

AC ✔️

[benbowler]

Hey @techanvil, I had a deep dive into the Tag Manager docs and API and it appears I can do what is required here using existing APIs. Did I miss a way that GTM can be configured where a tags/containers can be nested in a way that requires us to look up containers to check for Ads linking? If so can you share an example of how to set up tag manager to reach this case and I will update the IB.