Google Ads Connector - Using Stored Procs

T-SQL is a programming language used for managing and querying data in Microsoft SQL Server databases. We provides tools for data integration, automation, and connectivity.

If you want to use T-SQL with ZappySys, you can use our Connector, which allows you to connect to SQL Server databases and execute T-SQL queries from Google Ads.

Create Data Source in ZappySys Data Gateway based on API Driver

Download and install ZappySys ODBC PowerPack.
Search for gateway in start menu and Open ZappySys Data Gateway:
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

GoogleAdsDSN
When the Configuration window appears give your data source a name if you haven't done that already, then select "Google Ads" from the list of Popular Connectors. If "Google Ads" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

GoogleAdsDSN

Google Ads

Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

User Account [OAuth]

User accounts represent a developer, administrator, or any other person who interacts with Google APIs and services. User accounts are managed as Google Accounts, either with Google Workspace or Cloud Identity. They can also be user accounts that are managed by a third-party identity provider and federated with Workforce Identity Federation. [API reference]

Steps how to get and use Google Ads credentials

Follow these steps on how to create Client Credentials (User Account principle) to authenticate and access Google Ads API in SSIS package or ODBC data source:

WARNING: If you are planning to automate processes, we recommend that you use a Service Account authentication method. In case, you still need to use User Account, then make sure you use a system/generic account (e.g. automation@my-company.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will start to fail.

Manager Account Setup - Obtain Developer Token

To access Google Ads API (your data or someone else data) you must perform the following steps (high level). Detailed steps listed in the next sections.

Create a Google Ads Manager account (formally known as MCC).
Apply for Production data access (Upgrade Developer Token access Level to Basic).
Link manager account with Google Ads Account.
Create a new Project and obtain Client Id and Client Secret

Step-1: Create a Google Ads Manager account (formally known as MCC)

Very first step to access Google Ads API for your own account or someone else account, you will need something called Google Manager Account (formally known as MCC). It will look like a Normal Google Ads Account with some difference so dont get confused if you see similar interface as Ads account.
Click here to see detailed instructions on how to create a manager account. Once you created a manager account, you can login or switch between Ads account and Manager account like below. You can identify manager account using "Manager" word next to the account id when you click Profile dropdown.

Step-2: Obtain Developer Token

Once you have created and logged in to your Google Ads Manager Account (formally known as MCC) we are ready for the next step which is obtain Developer Token. To access Google Ads API you need to pass developer token in each API call. By default Developer Token is only allowed to access Sandbox (Test) account. If you like to access Production data (Live Ads Account) then you must apply for Basic Access by clicking link under Access Level (See next section for information).
Here is how to can obtain your Developer Token.

Log in as Manager account (Or change Top-Right Profile > Choose Manager account ID
Click on Admin icon
Click on API Center (This option will be missing if you are logged in to Regular Ads account as Client and not using Manager Account (MMC)
Expand Access Level, Click Apply for Basic Access if it says "Test". By default Developer Token is created with Test Account access only. To access Production Ads account you must apply for higher access level. Must be Basic or Standard (not Test). After click the link you will see form with few questions, please fill out that and submit the form. Apploval process may take 3-5 days (or longer in some cases if you did not provide enough information).
If your token is already approved for the basic access then copy the token and paste on the Google Ads Connector - Connection UI (For Developer Token property)

Click here to see detailed instructions on obtaining a developer token

Developer Token for Google Ads API Access in API Center (Visible when logged in as Manager Account)

Link Manager Account to Google Ads Account

After you have manager account ready, next step is to link manager account with Google Ads Account. You have to send invitation from Manager account to access Google Ads account (it can be your own account or someone else). Here is how to send invite to link Google Ads account.

Log in as Manager account (Or change Top-Right Profile > Choose Manager account ID
Click on Accounts icon > Sub-account settings > Send Link Request
Click on Add Sign (+) and select + Link existing account option
When prompted enter Account Id(s) you like to link with this Manager Account.
Click Send Request. You can find Ad Account Id usually at the Top-Right corner after you login to the Google Ads account.
Now ask Google Ads Account owner to check email. Click Accept Invitation link in the email (If prompted login as Google Ads Account owner).
-OR-
Another way to see Invitation, Login to Google Ads account (Or Switch from the Top-Right corner by clicking Profile icon). Go to Admin icon > Access and security > Managers Tab. Find the pending invitation and click ACCEPT.
That's it. Now your Manager account is linked to the Google Ads account

Obtain ClientId and ClientSecret

Step-1: Create project

This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

First of all, go to Google API Console.
Then click Select a project button and then click NEW PROJECT button:
Name your project and click CREATE button:
Wait until the project is created:
Done! Let's proceed to the next step.

Step-2: Enable Google Ads API

In this step we will enable Google Ads API:

Select your project on the top bar:
Then click the "hamburger" icon on the top left and access APIs & Services:
Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:
In the search bar search for Ads and then locate and select Google Ads API:
Enable Google Ads API:
Done! Let's proceed to the next step.

Step-3: Create OAuth application

First of all, click the "hamburger" icon on the top left and then hit VIEW ALL PRODUCTS:
Then access Google Auth Platform to start creating an OAuth application:
Start by pressing GET STARTED button:
Next, continue by filling in App name and User support email fields:
Choose Internal option, if it's enabled, otherwise select External:
Optional step if you used Internal option in the previous step. Nevertheless, if you had to use External option, then click ADD USERS to add a user:
Then add your contact Email address:
Finally, check the checkbox and click CREATE button:
Done! Let's create Client Credentials in the next step.

Step-4: Create Client Credentials

In Google Auth Platform, select Clients menu item and click CREATE CLIENT button:
Choose Desktop app as Application type and name your credentials:
Continue by opening the created credentials:
Finally, copy Client ID and Client secret for the later step:
Done! We have all the data needed for authentication, let's proceed to the last step!

Step-5: Configure connection

Now go to SSIS package or ODBC data source and use previously copied values in User Account authentication configuration:
- In the ClientId field paste the Client ID value.
- In the ClientSecret field paste the Client secret value.
- In the DeveloperToken field paste the Developer Token value.
Press Generate Token button to generate Access and Refresh Tokens.
Finally, click Test Connection to confirm the connection is working.
Done! Now you are ready to use Google Ads Connector!

Fill in all required parameters and set optional parameters if needed:

GoogleAdsDSN

Google Ads

User Account [OAuth]

https://googleads.googleapis.com/[$ApiVersion$]

Required Parameters
UseCustomApp	Fill-in the parameter...
CustomerId (without dash e.g. 2125557752)	Fill-in the parameter...
DeveloperToken	Fill-in the parameter...
Optional Parameters
ClientId
ClientSecret
Scope	https://www.googleapis.com/auth/adwords
Login CustomerId (without dash e.g. 2125557752)
Linked CustomerId (without dash e.g. 2125557752)
API Version	v19
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True
Redirect URL (Only for Web App)

Service Account [OAuth]

Service accounts are accounts that do not represent a human user. They provide a way to manage authentication and authorization when a human is not directly involved, such as when an application needs to access Google Cloud resources. Service accounts are managed by IAM. [API reference]

Steps how to get and use Google Ads credentials

To access Google Ads API (your data or someone else data) you must perform the following steps (high level). Detailed steps listed in the next sections.

Create a Manager account.
Apply for Production data access (Upgrade Developer Token access Level to Basic).
Link manager account with Google Ads Account.
Inside Manager account apply for Basic API Access level so you can use Developer Token to access Live data (Production Ads account). Without Basic access level Developer Token can be only used for Test / Sandbox Ads account.
Create a new Project and obtain Client Id and Client Secret

Manager Account Setup - Obtain Developer Token

To access Google Ads API (your data or someone else data) you must perform the following steps (high level). Detailed steps listed in the next sections.

Create a Google Ads Manager account (formally known as MCC).
Apply for Production data access (Upgrade Developer Token access Level to Basic).
Link manager account with Google Ads Account.
Create a new Project and obtain Service Account details

Step-1: Create a Google Ads Manager account (formally known as MCC)

Step-2: Obtain Developer Token

Log in as Manager account (Or change Top-Right Profile > Choose Manager account ID
Click on Admin icon
Click on API Center (This option will be missing if you are logged in to Regular Ads account as Client and not using Manager Account (MMC)
Expand Access Level, Click Apply for Basic Access if it says "Test". By default Developer Token is created with Test Account access only. To access Production Ads account you must apply for higher access level. Must be Basic or Standard (not Test). After click the link you will see form with few questions, please fill out that and submit the form. Apploval process may take 3-5 days (or longer in some cases if you did not provide enough information).
If your token is already approved for the basic access then copy the token and paste on the Google Ads Connector - Connection UI (For Developer Token property)

Click here to see detailed instructions on obtaining a developer token

Link Manager Account to Google Ads Account

Log in as Manager account (Or change Top-Right Profile > Choose Manager account ID
Click on Accounts icon > Sub-account settings > Send Link Request
Click on Add Sign (+) and select + Link existing account option
When prompted enter Account Id(s) you like to link with this Manager Account.
Click Send Request. You can find Ad Account Id usually at the Top-Right corner after you login to the Google Ads account.
Now ask Google Ads Account owner to check email. Click Accept Invitation link in the email (If prompted login as Google Ads Account owner).
-OR-
Another way to see Invitation, Login to Google Ads account (Or Switch from the Top-Right corner by clicking Profile icon). Go to Admin icon > Access and security > Managers Tab. Find the pending invitation and click ACCEPT.
That's it. Now your Manager account is linked to the Google Ads account

Obtain ClientId and ClientSecret

Step-1: Create project

This step is optional, if you already have a project in Google Cloud and can use it. However, if you don't, proceed with these simple steps to create one:

First of all, go to Google API Console.
Then click Select a project button and then click NEW PROJECT button:
Name your project and click CREATE button:
Wait until the project is created:
Done! Let's proceed to the next step.

Step-2: Enable Google Ads API

In this step we will enable Google Ads API:

Select your project on the top bar:
Then click the "hamburger" icon on the top left and access APIs & Services:
Now let's enable several APIs by clicking ENABLE APIS AND SERVICES button:
In the search bar search for ads and then locate and select Google Ads API:
Enable Google Ads API:
Done! Let's proceed to the next step.

Step-3: Create Service Account

Use the steps below to create a Service Account in Google Cloud:

First of all, go to IAM & Admin in Google Cloud console:
Once you do that, click Service Accounts on the left side and click CREATE SERVICE ACCOUNT button:
Then name your service account and click CREATE AND CONTINUE button:
Continue by clicking Select a role dropdown and start granting service account Project Viewer roles:
Find Project group and select Viewer role:
Finish adding roles by clicking CONTINUE button:

You can always add or modify permissions later in IAM & Admin.
Finally, in the last step, just click button DONE:
Done! We are ready to add a Key to this service account in the next step.

Step-4: Add Key to Service Account

We are ready to add a Key (JSON or P12 key file) to the created Service Account:

In Service Accounts open newly created service account:
Next, copy email address of your service account for the later step:
Continue by selecting KEYS tab, then press ADD KEY dropdown, and click Create new key menu item:
Finally, select JSON (Engine v19+) or P12 option and hit CREATE button:
Key file downloads into your machine. We have all the data needed for authentication, let's proceed to the last step!

Step-5: Give Permissions to Service Account

Now it's time to grant permission to Service Account we just created:

Login to https://ads.google.com/aw/settings/account with Google Ads account credentials (If propmpted choose your Ads account).
Go to Admin section, Access and security, Click on Users tab.
Click on Add Icon (+) and enter service account email address which you like to use for data access and choose permissions.
That's it! Let's proceed to the configuration!

Step-6: Configure connection

Now go to SSIS package or ODBC data source and configure these fields in Service Account authentication configuration:
- In the Service Account Email field paste the service account Email address value you copied in the previous step.
- In the Service Account Private Key Path (i.e. *.json OR *.p12) field use downloaded key file path.
Done! Now you are ready to use Google Ads Connector!

If you received an error saying DEVELOPER_TOKEN_PROHIBITED then read the following workaround.

Each Google API Console project can be associated with the developer token from only one manager account. Once you make a Google Ads API request, the developer token is permanently paired to the Google API Console project. If you don't use a new Google API Console project, you'll get a DEVELOPER_TOKEN_PROHIBITED error when making a request. Unfortunatly there is no other way to Unlink old Developer Token from the API Project, so for now just create a new Project as a workaround to fix this error.

Fill in all required parameters and set optional parameters if needed:

GoogleAdsDSN

Google Ads

Service Account [OAuth]

https://googleads.googleapis.com/[$ApiVersion$]

Required Parameters
Service Account Email	Fill-in the parameter...
Service Account Private Key Path (i.e. .json OR .p12)	Fill-in the parameter...
CustomerId (without dash e.g. 2125557752)	Fill-in the parameter...
DeveloperToken	Fill-in the parameter...
Optional Parameters
Scope	https://www.googleapis.com/auth/adwords
Login CustomerId (without dash e.g. 2125557752)
Linked CustomerId (without dash e.g. 2125557752)
API Version	v19
RetryMode	RetryWhenStatusCodeMatch
RetryStatusCodeList	429
RetryCountMax	5
RetryMultiplyWaitTime	True
Impersonate As (Google account email address)

Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
Click OK to finish creating the data source.

Read data in SQL Server using ZappySys Data Gateway

To read the data in SQL Server, the first thing you have to do is create a Linked Server:

First, let's open SQL Server Management Studio, create a new Linked Server, and start configuring it:
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
Optional step. Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

You need to enable RPC Out if you plan to use EXEC(...) AT [LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY] rather than OPENQUERY.
If don't enabled it, you will encounter the Server 'LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY' is not configured for RPC error.

Query Example:
```
EXEC('SELECT * from Products') AT [LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY]
```
If you plan to use 'INSERT INTO...EXEC(....) AT [LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

Query Example:
```
INSERT INTO dbo.Products
EXEC('SELECT * FROM Products') AT [LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY]
```

Finally, open a new query and execute a query we saved in one of the previous steps:

SELECT * FROM OPENQUERY([LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY], 'SELECT * FROM Products')

Execute query at Linked Server to ZappySys Data Gateway in SSMS

SELECT * FROM OPENQUERY([LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY], 'SELECT * FROM Products')

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'GoogleAdsDSN'


    USE [master]
    GO
    --///////////////////////////////////////////////////////////////////////////////////////
    --Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
    --///////////////////////////////////////////////////////////////////////////////////////

    //Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
    //Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
    //Replace Port 5000 if you configured gateway on a different port


    --1. Configure your gateway service as per this article https://zappysys.com/links?id=10036

    --2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

    --Uncomment below if you like to drop linked server if it already exists
    --EXEC master.dbo.sp_dropserver @server=N'LS_GoogleAdsDSN', @droplogins='droplogins'

    --3. Create new linked server

    EXEC master.dbo.sp_addlinkedserver
      @server = N'LS_GoogleAdsDSN'  --Linked server name (this will be used in OPENQUERY sql
    , @srvproduct=N''
    ---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
    , @provider=N'SQLNCLI11'
    ---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
    --, @provider=N'MSOLEDBSQL'
    , @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
    , @provstr=N'Network Library=DBMSSOCN;'
    , @catalog=N'GoogleAdsDSN' --Data source name you gave on Gateway service settings

    --4. Attach gateway login with linked server

    EXEC master.dbo.sp_addlinkedsrvlogin
    @rmtsrvname=N'LS_GoogleAdsDSN'  --linked server name
    , @useself=N'False'
    , @locallogin=NULL
    , @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
    , @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
    GO

    --5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
    EXEC sp_serveroption 'LS_GoogleAdsDSN', 'rpc', true;
    EXEC sp_serveroption 'LS_GoogleAdsDSN', 'rpc out', true;

    --Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
    EXEC sp_serveroption 'LS_GoogleAdsDSN', 'remote proc transaction promotion', false;

    --Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
    --EXEC sp_serveroption 'LS_GoogleAdsDSN', 'query timeout', 1200;
    GO

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
```
CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
 AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>';
```
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
```
Exec usp_get_orders '1996-01-01';
```
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([LINKED_SERVER_TO_GOOGLE_ADS_IN_DATA_GATEWAY], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
```
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.