COOKiES 同意管理
User consent management module for Drupal that enables GDPR-compliant cookie handling and third-party service integration with a fully configurable, translatable user interface.
cookies
インストール
composer require 'drupal/cookies:^1.2'
概要
COOKiESは、GDPRおよび類似のプライバシー規制に準拠する必要があるDrupalサイト向けの包括的なユーザー同意管理ソリューションです。このモジュールにより、既存のサードパーティ統合モジュールを引き続き使用しながら、Cookieがインストールされる前にユーザーの同意を得ることができます。
cookiesJSR JavaScriptライブラリをベースに構築されたCOOKiESは、サービスカテゴリ（トラッキング、マーケティング、ソーシャル、機能、動画、パフォーマンス）を細かく制御できる、完全レスポンシブで翻訳可能なCookie同意バナーを提供します。サイト管理者は、詳細な処理者情報、プライバシーポリシーリンク、コンテンツがブロックされた際に表示されるカスタムプレースホルダーテキストを含む個々のサービスを設定できます。
このモジュールは、設定されたすべてのサービスとそのデータ処理の詳細を一覧表示するGDPR準拠のドキュメントを自動生成します。このドキュメントは、専用ページとして表示したり、Blockを介して埋め込んだり、[cookies:docs]トークンを使用して挿入したりできます。認証済みユーザーの場合、同意設定をデータベースに保存し、異なるブラウザやセッション間で復元できます。
重要：GDPRへの準拠に関する責任は一切負いません。サイト管理者は、適切な設定と法的コンプライアンスを確保する責任があります。
Features
- すべて許可、すべて拒否、および詳細設定オプションを備えた完全レスポンシブのCookie同意バナー
- DrupalのConfiguration Translation システムによるすべてのUIテキストの完全な翻訳サポート
- 設定可能なサービスグループ（トラッキング、マーケティング、ソーシャル、機能、動画、パフォーマンス）によるグループレベルまたは個別サービスの同意管理
- 処理者の詳細、プライバシーポリシー、Cookie情報を表示する自動生成のGDPR準拠ドキュメント
- ブラウザやセッションをまたいだ認証済みユーザーの永続的な同意保存
- cookies_filterサブモジュールによる外部コンテンツ（iframe、埋め込み、動画）のツークリックソリューション
- CSS変数またはスタイルシート全体の置き換えによるカスタマイズ可能なCSSスタイリング
- コンテンツにCookieドキュメントを埋め込むためのトークンサポート（[cookies:docs]）
- CDNまたはローカルインストールからのJavaScriptライブラリ読み込み
- ページ速度向上のためのスクロールトリガーによるバナー表示オプション
- 名前、有効期限、ドメイン、Secureフラグ、SameSite属性を含むCookie設定の構成
- Cookie設定ダイアログを開くためのToolsメニュー内の動的メニューリンク
Use Cases
Basic GDPR Cookie Consent
Install COOKiES and place the Cookies UI block in your theme. Configure service groups and services matching your site's third-party integrations. Add links to privacy policy and imprint pages. Users see consent banner on first visit and can adjust preferences anytime via the settings dialog.
Google Tag Manager Integration
Enable cookies_gtag submodule alongside google_tag module. A 'gtag' service is automatically created. GTM scripts won't load until user accepts tracking cookies. Configure processor details with Google LLC information for documentation.
Video Embedding with Consent
Enable cookies_video submodule. Video media embeds (YouTube, Vimeo) display a placeholder with consent button instead of loading immediately. User can accept video cookies specifically or accept all cookies.
Custom Third-Party Service Integration
Create a new COOKiES service entity for your custom integration. In your module, use the cookies.knock_out service to check if blocking is needed. Listen for cookiesjsrUserConsent JavaScript events to initialize your service when consent is given. Use the cookiesOverlay() jQuery plugin to display placeholders.
Multilingual Cookie Consent
All COOKiES texts are translatable via Drupal's configuration translation. Go to /admin/config/system/cookies/texts/translate to add translations for each language. Service documentation and group descriptions also support translation.
Group-Level Consent for Simplified UI
Enable 'Group consent' in COOKiES configuration. Users see only service groups (Tracking, Marketing, etc.) without individual service toggles. Combine with 'Display cookie documentation links' to provide detailed service information on a separate page.
Authenticated User Consent Persistence
Enable 'Store consent for authenticated users' in callback options. Logged-in users' preferences are saved to the database. When they log in on a different browser, their consent preferences are automatically restored.
Two-Click Solution for Text Content
Enable cookies_filter submodule. Add the COOKiES Filter to a text format. Content with iframes, embeds, or external images shows a consent placeholder. Users must click to accept cookies before external content loads.
Tips
- Use CSS variables to customize the cookie banner appearance without completely replacing the stylesheet. See the cookiesJSR documentation for available variables.
- The [cookies:docs] token can be used in content to embed cookie documentation anywhere, such as on your privacy policy page.
- Set scroll limit to a value >= 1 to defer library loading and improve page speed scores.
- For GDPR compliance in Italy, enable 'Deny all services on Layer close' to treat the X button as a deny action.
- When creating custom service integrations, use consistent machine names between your service entity and JavaScript service key.
- Add processor company details (privacy policy URL, contact) to provide comprehensive GDPR documentation automatically.
- Use group consent mode with documentation links when you have many services to simplify the user interface.
Technical Details
Admin Pages 6
/admin/config/system/cookies
Overview page providing access to all COOKiES configuration sections including base configuration, widget texts, service groups, and individual services.
/admin/config/system/cookies/config
Configure the core settings for the COOKiES consent management system including cookie properties, banner behavior, settings dialog options, JavaScript library settings, styling, and callback options.
/admin/config/system/cookies/texts
Configure all translatable text labels, messages, and links displayed in the cookie consent UI. All texts support Drupal's configuration translation system for multilingual sites.
/admin/config/system/cookies/cookies-service-group
Manage service groups that organize individual cookie services into categories (e.g., Tracking, Marketing, Social). Groups are displayed as tabs in the settings dialog and organize the cookie documentation.
/admin/config/system/cookies/cookies-service
Manage individual cookie services representing third-party integrations that require user consent. Each service belongs to a group and can have detailed processor information, custom placeholder texts, and documentation.
/cookies/documentation
Public-facing page displaying comprehensive documentation of all configured cookie services, organized by group. Shows processor details, privacy policy links, and service descriptions as required by GDPR.
権限 3
Hooks 1
hook_cookies_user_consent
Invoked when a user changes their cookie consent preferences. Use this hook to perform backend operations based on consent changes while maintaining site cacheability.
Troubleshooting 6
Ensure the 'Cookies UI' block is placed in your theme's block layout and is visible (check block visibility settings). Verify the block is assigned to the correct theme. Check browser console for JavaScript errors.
When 'Load Cookies JSR from CDN' is disabled, the library must be installed at /libraries/cookiesjsr/dist/cookiesjsr.min.js. Download from https://github.com/jfeltkamp/cookiesjsr and place in the correct location.
Verify the service entity has 'Consent required' enabled. Check that your integration code uses the cookies.knock_out service to determine blocking. Ensure the COOKiES UI block is accessible on the pages where blocking should occur.
COOKiES uses configuration translation. Navigate to /admin/config/system/cookies/texts and click 'Translate' to add translations for each language. Clear caches after adding translations.
Ensure your menu link uses the correct hash format: #editCookieSettings (or your configured value). The COOKiES UI block must be present on the page for the dialog to open.
Enable 'Store consent for authenticated users' in /admin/config/system/cookies/config under Callback options. This stores consent in key-value storage and restores it on login.
Security Notes 5
- No liability is assumed regarding GDPR compliance. Site administrators are responsible for proper configuration and legal compliance.
- Configure the cookie SameSite attribute appropriately: 'Strict' provides the most security but may affect cross-site functionality.
- Enable 'Secure mode' (HTTPS only) for production sites to prevent cookie transmission over unencrypted connections.
- The cookie storing consent preferences contains no personally identifiable information - only service acceptance flags.
- When storing authenticated user consent, preferences are tied to user ID and stored in Drupal's key-value storage.