How to Build an ETL App for Microsoft Ads Data in Python with CData

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for Microsoft Ads and the petl framework, you can build Microsoft Ads-connected applications and pipelines for extracting, transforming, and loading Microsoft Ads data. This article shows how to connect to Microsoft Ads with the CData Python Connector and use petl and pandas to extract, transform, and load Microsoft Ads data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Microsoft Ads data in Python. When you issue complex SQL queries from Microsoft Ads, the driver pushes supported SQL operations, like filters and aggregations, directly to Microsoft Ads and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Microsoft Ads Data

Connecting to Microsoft Ads data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

The Microsoft Ads APIs use the OAuth 2 standard. To authenticate, you will need valid Microsoft Ads OAuth credentials and obtain a developer token. See the Getting Started section in the Microsoft Ads data provider help documentation for an authentication guide.

After installing the CData Microsoft Ads Connector, follow the procedure below to install the other required modules and start accessing Microsoft Ads through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for Microsoft Ads Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.microsoftads as mod

You can now connect with a connection string. Use the connect function for the CData Microsoft Ads Connector to create a connection for working with Microsoft Ads data.

cnxn = mod.connect(" OAuthClientId=MyOAuthClientId; OAuthClientSecret=MyOAuthClientSecret; CallbackURL=http://localhost:portNumber; AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;InitiateOAuth=GETANDREFRESH;")

Create a SQL Statement to Query Microsoft Ads

Use SQL to create a statement for querying Microsoft Ads. In this article, we read data from the AdGroups entity.

sql = "SELECT Id, Name FROM AdGroups WHERE CampaignId = '234505536'"

Extract, Transform, and Load the Microsoft Ads Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Microsoft Ads data. In this example, we extract Microsoft Ads data, sort the data by the Name column, and load the data into a CSV file.

Loading Microsoft Ads Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Name')

etl.tocsv(table2,'adgroups_data.csv')

In the following example, we add new rows to the AdGroups table.

Adding New Rows to Microsoft Ads

table1 = [ ['Id','Name'], ['NewId1','NewName1'], ['NewId2','NewName2'], ['NewId3','NewName3'] ]

etl.appenddb(table1, cnxn, 'AdGroups')

With the CData Python Connector for Microsoft Ads, you can work with Microsoft Ads data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Microsoft Ads to start building Python apps and scripts with connectivity to Microsoft Ads data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.microsoftads as mod

cnxn = mod.connect(" OAuthClientId=MyOAuthClientId; OAuthClientSecret=MyOAuthClientSecret; CallbackURL=http://localhost:portNumber; AccountId=442311; CustomerId=5521444; DeveloperToken=11112332233;InitiateOAuth=GETANDREFRESH;")

sql = "SELECT Id, Name FROM AdGroups WHERE CampaignId = '234505536'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Name')

etl.tocsv(table2,'adgroups_data.csv')

table3 = [ ['Id','Name'], ['NewId1','NewName1'], ['NewId2','NewName2'], ['NewId3','NewName3'] ]

etl.appenddb(table3, cnxn, 'AdGroups')