.. include:: Includes.txt

.. _installation:

Installation
============


There are two ways to install the **Google Ads for TYPO3** integration, using composer or manually downloading the extension from the TYPO3 Extension Repository (TER).

For using composer, please use this command:
:shell:`composer require t3g/google-ads`.

For downloading the extension from the TYPO3 Extension Repository (TER), please use this link: 
https://extensions.typo3.org/extension/google_ads/

Install and activate the extension. You will now find the *GOOGLE ADS* module in your module list.


.. important::

   You have to either disable any kind of AdBlocker or whitelist the URL of the TYPO3 installation.

   Also please inform your editors that the extension will not work when an AdBlocker is active.


The following steps have to be taken as an administrator or an editor user with permissions to modify the ``tx_googleads_*``
tables and with access to Google Ads sub modules:

.. _installation-storage-folder:

Storage Folder
--------------


First, find a place for the storage folder to reside in your page tree. 
Once the folder is created navigate to the folder's properties and go to the behaviour tab. 
Select *Google Ads Storage* for the field *Contains Plugin*. 

.. note::
    The storage folder needs to be accessible for editors creating ads. Please make sure it is in the intended database mount.

.. _installation-mgmt-module:

Google Ads Management Module
----------------------------

The next step is to connect the extension with a `Google Ads for TYPO3 <https://google-ads.api.typo3.com>`_ account. 

When you access the module for the first time you will see a *Start Setup* and a *Register a new Google Ads for TYPO3 account* button.

.. figure:: Images/Installation/01-MgmtMod-Connect.png
   :alt: Register to **Google Ads for TYPO3**.
   :class: with-border

   Register to **Google Ads for TYPO3**.

You will most likely not have registered an account, yet. You can register an account by clicking on the *Register a new Google Ads for TYPO3 account* button. The registration form will open in a new browser tab. 
Register an account by providing your first name, last name, email address and a password. A confirmation email will be sent to the email address you provided.

After the registration process is completed, navigate to the management module and click on the *Start Setup* button.
In the following view, please fill in your login credentials. Optionally, you can configure the notification settings and the instance name. 

.. figure:: Images/Installation/02-MgmtMod-Setup-Form.png
   :alt: TYPO3 backend asking for login credentials
   :class: with-border

   TYPO3 backend asking for login credentials

Click on the *Set up Instance* button when you're done filling in the necessary fields.
You will then be asked to provide a Google Ads account that will be connected to the **Google Ads for TYPO3** integration. 
This is done by using the `Google Ads for TYPO3 <https://google-ads.api.typo3.com>`_ interface. 
You will receive a confirmation email by Google where you need to authorize the connection between the Google Ads account and the **Google Ads for TYPO3** account.

After you finished connecting the Google Ads account to your **Google Ads for TYPO3** account, the management module in your TYPO3 instance will provide you with a list of Google Ads account IDs to choose from. 
Click on the *Connect* button to connect your Google Ads account to the TYPO3 instance.

.. note::

   Ads created by the **Google Ads for TYPO3** integration will only show up, if the Google Ads account is connected to a valid credit card.

.. figure:: Images/Installation/03-MgmtMod-no-Google-Acc-yet.png
   :alt: Connection to **Google Ads for TYPO3** has been established.
   :class: with-border

   Connection to **Google Ads for TYPO3** has been established.