-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #971 from matomo-org/PG-4039-google-consent-tag
Adds Google consent mode tag, #PG-4039
- Loading branch information
Showing
13 changed files
with
291 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * Matomo - free/libre analytics platform | ||
| * | ||
| * @link https://matomo.org | ||
| * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later | ||
| */ | ||
|
|
||
| namespace Piwik\Plugins\TagManager\Template\Tag; | ||
|
|
||
| use Piwik\Piwik; | ||
| use Piwik\Settings\FieldConfig; | ||
| use Piwik\Url; | ||
| use Piwik\Validators\NotEmpty; | ||
|
|
||
| class GoogleConsentModeV2Tag extends BaseTag | ||
| { | ||
| public function getName() | ||
| { | ||
| // By default, the name will be automatically fetched from the TagManager_CustomHtmlTagName translation key. | ||
| // you can either adjust/create/remove this translation key, or return a different value here directly. | ||
| return parent::getName(); | ||
| } | ||
|
|
||
| public function getDescription() | ||
| { | ||
| // By default, the description will be automatically fetched from the TagManager_CustomHtmlTagDescription | ||
| // translation key. you can either adjust/create/remove this translation key, or return a different value | ||
| // here directly. | ||
| return parent::getDescription(); | ||
| } | ||
|
|
||
| public function getHelp() | ||
| { | ||
| // By default, the help will be automatically fetched from the TagManager_CustomHtmlTagHelp translation key. | ||
| // you can either adjust/create/remove this translation key, or return a different value here directly. | ||
| return parent::getHelp(); | ||
| } | ||
|
|
||
| public function getCategory() | ||
| { | ||
| return Piwik::translate('TagManager_ConsentManagement'); | ||
| } | ||
|
|
||
| public function getIcon() | ||
| { | ||
| // You may optionally specify a path to an image icon URL, for example: | ||
| // | ||
| // return 'plugins/TagManager/images/MyIcon.png'; | ||
| // | ||
| // to not return default icon call: | ||
| // return parent::getIcon(); | ||
| // | ||
| // The image should have ideally a resolution of about 64x64 pixels. | ||
| return 'plugins/TagManager/images/icons/google-consent-mode.svg'; | ||
| } | ||
|
|
||
| public function getParameters() | ||
| { | ||
| $default = [ | ||
| ['consent_type' => 'ad_storage', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'ad_user_data', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'ad_personalization', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'analytics_storage', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'functionality_storage', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'personalization_storage', 'consent_state' => 'granted'], | ||
| ['consent_type' => 'security_storage', 'consent_state' => 'granted'], | ||
| ]; | ||
|
|
||
| return array( | ||
| $this->makeSetting('consentAction', 'update', FieldConfig::TYPE_ARRAY, function (FieldConfig $field) { | ||
| $field->title = Piwik::translate('TagManager_GoogleConsentModeV2TagConsentActionTitle'); | ||
| $field->description = Piwik::translate('TagManager_GoogleConsentModeV2TagConsentActionDescription'); | ||
| $field->uiControl = FieldConfig::UI_CONTROL_SINGLE_SELECT; | ||
| $field->availableValues = array( | ||
| 'default' => 'default', | ||
| 'update' => 'update', | ||
| ); | ||
| $field->validators[] = new NotEmpty(); | ||
| }), | ||
|
|
||
| $this->makeSetting('consentTypes', $default, FieldConfig::TYPE_ARRAY, function (FieldConfig $field) { | ||
| $field->uiControl = FieldConfig::UI_CONTROL_MULTI_TUPLE; | ||
| $field->title = Piwik::translate('TagManager_GoogleConsentModeV2TagConsentTypesTitle'); | ||
| $faqURL = Url::addCampaignParametersToMatomoLink('https://matomo.org/faq/tag-manager/google-consent-tag-in-matomo-tag-manager/', null, null, 'Tag.TagManager.GoogleConsentMode'); | ||
| $field->inlineHelp = Piwik::translate('TagManager_GoogleConsentModeV2TagConsentTypesDescription', ['<a href="' . $faqURL . '" target="_blank" rel="noreferrer noopener">', '</a>']); | ||
|
|
||
| $field1 = new FieldConfig\MultiPair(Piwik::translate('TagManager_GoogleConsentModeV2TagConsentTypeTitle'), 'consent_type', FieldConfig::UI_CONTROL_TEXT); | ||
| $field1->customFieldComponent = self::FIELD_VARIABLE_COMPONENT; | ||
|
|
||
| $field2 = new FieldConfig\MultiPair(Piwik::translate('TagManager_GoogleConsentModeV2TagConsentStateTitle'), 'consent_state', FieldConfig::UI_CONTROL_TEXT); | ||
| $field2->customFieldComponent = self::FIELD_VARIABLE_COMPONENT; | ||
|
|
||
| $field->uiControlAttributes['field1'] = $field1->toArray(); | ||
| $field->uiControlAttributes['field2'] = $field2->toArray(); | ||
| }), | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| (function () { | ||
| return function (parameters, TagManager) { | ||
| this.fire = function () { | ||
|
|
||
| var consentAction = parameters.get("consentAction")[0]; | ||
| var consentTypes = parameters.get("consentTypes"); | ||
|
|
||
| var typesObject = {}; | ||
| consentTypes.forEach(function (type) { | ||
| if (type.consent_type && type.consent_state) { | ||
| typesObject[type.consent_type] = type.consent_state; | ||
| } | ||
| }); | ||
|
|
||
| window.dataLayer = window.dataLayer || []; | ||
| function gtag() { | ||
| window.dataLayer.push(arguments); | ||
| } | ||
| gtag("consent", consentAction, typesObject); | ||
|
|
||
| }; | ||
| }; | ||
| })(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions
4
...UI/expected-screenshots/ContainerTag_create_new_custom_templates_restricted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.