GoogleAnalytics4/metadata.php

242 lines
12 KiB
PHP
Raw Normal View History

2021-07-17 23:22:23 +02:00
<?php
2024-05-29 11:39:53 +02:00
use D3\GoogleAnalytics4\Application\Controller\Admin\GA4AdminUserInterface_main as GA4AdminUserInterfaceMainController;
use D3\GoogleAnalytics4\Application\Model\Constants as Constants;
use D3\GoogleAnalytics4\Modules\Application\Component\d3GtmBasketComponentExtension;
use D3\GoogleAnalytics4\Modules\Application\Component\Widget\d3GtmWidgetArticleDetails as d3GtmWidgetArticleDetails;
use D3\GoogleAnalytics4\Modules\Application\Controller\ArticleDetailsController;
use D3\GoogleAnalytics4\Modules\Application\Controller\ArticleListController_AddToCartHelpMethods;
2023-08-03 14:57:26 +02:00
use D3\GoogleAnalytics4\Modules\Application\Controller\BasketController;
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountNoticeListController;
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountRecommlistController;
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmAccountWishlistController;
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmManufacturerListController as d3GtmManufacturerListController;
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmSearchController;
2023-12-18 11:23:43 +01:00
use D3\GoogleAnalytics4\Modules\Application\Controller\d3GtmStartController;
use D3\GoogleAnalytics4\Modules\Application\Controller\ThankYouController;
use D3\GoogleAnalytics4\Modules\Application\Model\Basket as Basket;
use D3\GoogleAnalytics4\Modules\Application\Model\Category as Category;
2023-08-15 11:52:46 +02:00
use D3\GoogleAnalytics4\Modules\Application\Model\Manufacturer as Manufacturer;
use D3\GoogleAnalytics4\Modules\Core\ViewConfig;
use OxidEsales\Eshop\Application\Component\BasketComponent as OEBasketComponent;
use OxidEsales\Eshop\Application\Component\Widget\ArticleDetails as OEArticleDetails;
use OxidEsales\Eshop\Application\Controller\AccountNoticeListController as OEAccountNoticeListController;
use OxidEsales\Eshop\Application\Controller\AccountRecommlistController as OEAccountRecommlistController;
use OxidEsales\Eshop\Application\Controller\AccountWishlistController as OEAccountWishlistController;
use OxidEsales\Eshop\Application\Controller\ArticleDetailsController as OEArticleDetailsController;
use OxidEsales\Eshop\Application\Controller\ArticleListController as OEArticleListController;
2023-08-03 14:57:26 +02:00
use OxidEsales\Eshop\Application\Controller\BasketController as OEBasketController;
use OxidEsales\Eshop\Application\Controller\ManufacturerListController as OEManufacturerListController;
use OxidEsales\Eshop\Application\Controller\SearchController as OESearchController;
2023-12-18 11:23:43 +01:00
use OxidEsales\Eshop\Application\Controller\StartController as OEStartController;
use OxidEsales\Eshop\Application\Controller\ThankYouController as OEThankYouController;
use OxidEsales\Eshop\Application\Model\Basket as OEBasket;
use OxidEsales\Eshop\Application\Model\Category as OECategory;
2023-08-15 11:52:46 +02:00
use OxidEsales\Eshop\Application\Model\Manufacturer as OEManufacturer;
use OxidEsales\Eshop\Core\ViewConfig as OEViewConfig;
2021-07-17 23:22:23 +02:00
$sMetadataVersion = '2.1';
2022-06-09 20:41:59 +02:00
$aModule = [
'id' => Constants::OXID_MODULE_ID,
'title' => 'Google Analytics 4',
2023-01-20 09:33:36 +01:00
'description' => "Dieses Modul bietet die Möglichkeit in Ihrem OXID eShop (6.x) die neue 'Property'
Google Analytics 4 (GA4) von Google zu integrieren.<br>
Hierfür stehen Ihnen verschiedene 'templates' zur verfügung,
mit denen Sie bestimmte Events tracken können.<br>
2023-01-20 11:04:22 +01:00
Beispiele dafür sind: view_item, add_to_basket, purchase, ...<br><br>
Die Integration und Verbindung zu Google wird mithilfe des gtag (Google Tag Manager) realisiert.<br><br>
Weiterführende Informationen: https://developers.google.com/analytics/devguides/collection/ga4<br>
<hr>
Die Entwicklung basiert auf einem Fork von Marat Bedoev - <a href='https://github.com/vanilla-thunder/oxid-module-gtm'>Github-Link</a>
2023-01-20 09:33:36 +01:00
",
2022-06-09 20:41:59 +02:00
'thumbnail' => 'thumbnail.png',
2024-04-11 11:42:24 +02:00
'version' => '2.17.2',
'author' => 'Data Development (Inh.: Thomas Dartsch)',
'email' => 'support@shopmodule.com',
'url' => 'https://www.oxidmodule.com/',
2024-05-29 11:39:53 +02:00
'controllers' => [
'd3googleanalytics4_main' => GA4AdminUserInterfaceMainController::class
],
2022-06-09 20:41:59 +02:00
'extend' => [
// Core
OEViewConfig::class => ViewConfig::class,
// Model
OECategory::class => Category::class,
OEBasket::class => Basket::class,
OEManufacturer::class => Manufacturer::class,
// Controller
OEBasketController::class => BasketController::class,
OEThankYouController::class => ThankYouController::class,
OEArticleListController::class => ArticleListController_AddToCartHelpMethods::class,
OEArticleDetailsController::class => ArticleDetailsController::class,
OEAccountNoticeListController::class => d3GtmAccountNoticeListController::class,
OEAccountRecommlistController::class => d3GtmAccountRecommlistController::class,
2023-12-18 11:23:43 +01:00
OEAccountWishlistController::class => d3GtmAccountWishlistController::class,
OEStartController::class => d3GtmStartController::class,
OESearchController::class => d3GtmSearchController::class,
OEManufacturerListController::class => d3GtmManufacturerListController::class,
// Component
OEArticleDetails::class => d3GtmWidgetArticleDetails::class,
OEBasketComponent::class => d3GtmBasketComponentExtension::class,
],
'templates' => [
// Event files that store the GA4 Event-Information
'event/add_to_cart.tpl' => 'd3/googleanalytics4/Application/views/event/add_to_cart.tpl',
'event/view_item.tpl' => 'd3/googleanalytics4/Application/views/event/view_item.tpl',
'event/view_cart.tpl' => 'd3/googleanalytics4/Application/views/event/view_cart.tpl',
'event/purchase.tpl' => 'd3/googleanalytics4/Application/views/event/purchase.tpl',
'event/view_item_list.tpl' => 'd3/googleanalytics4/Application/views/event/view_item_list.tpl',
'event/view_search_result.tpl' => 'd3/googleanalytics4/Application/views/event/view_search_result.tpl',
'event/remove_from_cart.tpl' => 'd3/googleanalytics4/Application/views/event/remove_from_cart.tpl',
// complete overwritten file of OXID-Originals
// the path of the template-name is the original path to the file in OXID-context from tpl/->
'page/account/d3gtmnoticelist.tpl' => 'd3/googleanalytics4/Application/views/tpl/page/account/d3gtmnoticelist.tpl',
'page/account/d3gtmrecommendationlist.tpl' => 'd3/googleanalytics4/Application/views/tpl/page/account/d3gtmrecommendationlist.tpl',
'page/account/d3gtmwishlist.tpl' => 'd3/googleanalytics4/Application/views/tpl/page/account/d3gtmwishlist.tpl',
2024-05-29 11:39:53 +02:00
// Admin Templates
'ga4/admin/d3ga4uimain.tpl' => 'd3/googleanalytics4/Application/views/admin/tpl/d3googleanalytics4_main.tpl',
2021-07-17 23:22:23 +02:00
],
2022-06-09 20:41:59 +02:00
'blocks' => [
2021-07-17 23:22:23 +02:00
// tag manager js
[
'template' => 'layout/base.tpl',
2022-06-09 20:41:59 +02:00
'block' => 'head_meta_robots',
2023-05-24 11:09:36 +02:00
'file' => '/Application/views/blocks/_gtm_js.tpl',
'position' => 150
2021-07-17 23:22:23 +02:00
],
// tag manager nojs
[
'template' => 'layout/base.tpl',
2022-06-09 20:41:59 +02:00
'block' => 'theme_svg_icons',
'file' => '/Application/views/blocks/_gtm_nojs.tpl'
2021-07-17 23:22:23 +02:00
],
// details
[
'template' => 'page/details/inc/productmain.tpl',
2022-06-09 20:41:59 +02:00
'block' => 'details_productmain_title',
'file' => '/Application/views/blocks/view_item.tpl',
'position' => 150
2021-07-17 23:22:23 +02:00
],
// checkout
[
'template' => 'page/checkout/basket.tpl',
2022-06-09 20:41:59 +02:00
'block' => 'checkout_basket_main',
'file' => '/Application/views/blocks/view_cart.tpl'
2021-07-17 23:22:23 +02:00
],
[
'template' => 'page/checkout/thankyou.tpl',
2022-06-09 20:41:59 +02:00
'block' => 'checkout_thankyou_main',
2023-06-21 15:47:06 +02:00
'file' => '/Application/views/blocks/purchase.tpl'
2023-01-10 14:22:49 +01:00
],
// Lists
// view_item_list
[
'template' => 'page/list/list.tpl',
'block' => 'page_list_productlist',
'file' => '/Application/views/blocks/view_item_list.tpl',
2023-01-26 15:31:45 +01:00
'position' => 150
2023-01-10 15:49:54 +01:00
],
// view_search_result
[
'template' => 'page/search/search.tpl',
'block' => 'search_results',
'file' => '/Application/views/blocks/view_search_result.tpl',
2023-01-26 15:31:45 +01:00
'position' => 150
2023-01-11 14:43:13 +01:00
],
// add_to_cart
[
'template' => 'page/details/inc/productmain.tpl',
'block' => 'details_productmain_tobasket',
'file' => '/Application/views/blocks/details_productmain_tobasket.tpl',
'position' => 150
2023-08-17 08:51:02 +02:00
],
[
'template' => 'page/list/list.tpl',
'block' => 'page_list_listbody',
'file' => '/Application/views/blocks/page_list_listbody.tpl',
'position' => 150
],
2023-12-18 11:23:43 +01:00
[
'template' => 'page/shop/start.tpl',
'block' => 'start_welcome_text',
'file' => '/Application/views/blocks/start_welcome_text.tpl',
'position' => 150
2023-08-03 14:57:26 +02:00
],
// remove_from_cart
[
'template' => 'page/checkout/basket.tpl',
'block' => 'checkout_basket_main',
'file' => '/Application/views/blocks/remove_from_cart.tpl',
2023-08-03 14:57:26 +02:00
'position' => 150
2021-07-17 23:22:23 +02:00
]
],
2022-06-09 20:41:59 +02:00
'settings' => [
2021-07-17 23:22:23 +02:00
[
'group' => Constants::OXID_MODULE_ID.'_settings',
'name' => Constants::OXID_MODULE_ID.'_sContainerID',
'type' => 'str',
'value' => 'GTM-',
'position' => 0
2021-07-17 23:22:23 +02:00
],
[
'group' => Constants::OXID_MODULE_ID.'_settings',
'name' => Constants::OXID_MODULE_ID.'_blGA4enab',
'type' => 'bool',
'value' => true,
'position' => 1
2021-07-17 23:22:23 +02:00
],
2022-06-09 20:41:59 +02:00
[
'group' => Constants::OXID_MODULE_ID.'_settings',
'name' => Constants::OXID_MODULE_ID.'_blEnableDebug',
'type' => 'bool',
'value' => false,
'position' => 999
2023-01-17 14:42:17 +01:00
],
[
'group' => Constants::OXID_MODULE_ID.'_settings',
'name' => Constants::OXID_MODULE_ID.'_blActivateConsentMode',
'type' => 'bool',
'value' => false,
'position' => 999
],
2023-01-17 14:42:17 +01:00
[
'group' => Constants::OXID_MODULE_ID.'_cookiemanager',
'name' => Constants::OXID_MODULE_ID.'_hasOwnCookieManager',
'type' => 'bool',
'value' => false,
'position' => 999
2023-01-17 14:42:17 +01:00
],
[
'group' => Constants::OXID_MODULE_ID.'_cookiemanager',
'name' => Constants::OXID_MODULE_ID.'_controlParameter',
'type' => 'str',
'value' => '',
'position' => 999
2023-01-17 14:42:17 +01:00
],
[
'group' => Constants::OXID_MODULE_ID.'_cookiemanager',
'name' => Constants::OXID_MODULE_ID.'_HAS_STD_MANAGER',
'type' => 'select',
'value' => 'none',
2023-09-07 15:08:06 +02:00
'constraints' => 'NONE|CONSENTMANAGER|USERCENTRICS|COOKIEFIRST|COOKIEBOT',
],
// OST929760 - Erweiterung für Serverside Tagging
[
'group' => Constants::OXID_MODULE_ID.'_serversidetagging',
'name' => Constants::OXID_MODULE_ID.'_serversidetagging_js',
'type' => 'str',
'value' => 'https://www.googletagmanager.com/gtm.js',
],
[
'group' => Constants::OXID_MODULE_ID.'_serversidetagging',
'name' => Constants::OXID_MODULE_ID.'_serversidetagging_nojs',
'type' => 'str',
'value' => 'https://www.googletagmanager.com/ns.html',
],
2021-07-17 23:22:23 +02:00
]
];