Learn more
 

Ready to get started?

Download a free trial of the Bing Ads Connector to get started:

 Download Now

Learn more:

Bing Ads Icon Bing Ads Python Connector

Python Connector Libraries for Bing Ads Data Connectivity. Integrate Bing Ads with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

In this article

Related articles

How to use SQLAlchemy ORM to access Bing Ads Data in Python


Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Bing Ads data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Bing Ads and the SQLAlchemy toolkit, you can build Bing Ads-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Bing Ads data to query, update, delete, and insert Bing Ads data.

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

Connecting to Bing Ads Data

Connecting to Bing 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 Bing Ads APIs use the OAuth 2 standard. To authenticate, you will need valid Bing Ads OAuth credentials and you will need to obtain a developer token. See the Getting Started section in the Bing Ads data provider help documentation for an authentication guide.

Follow the procedure below to install SQLAlchemy and start accessing Bing Ads through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker

Model Bing Ads Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Bing Ads data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("bingads:///? OAuthClientId=MyOAuthClientId& OAuthClientSecret=MyOAuthClientSecret& CallbackURL=http://localhost:portNumber& AccountId=442311& CustomerId=5521444& DeveloperToken=11112332233&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for Bing Ads Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the AdGroups table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base() class AdGroups(base): __tablename__ = "AdGroups" Id = Column(String,primary_key=True) Name = Column(String) ...

Query Bing Ads Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("bingads:///? OAuthClientId=MyOAuthClientId& OAuthClientSecret=MyOAuthClientSecret& CallbackURL=http://localhost:portNumber& AccountId=442311& CustomerId=5521444& DeveloperToken=11112332233&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(AdGroups).filter_by(CampaignId="234505536"): print("Id: ", instance.Id) print("Name: ", instance.Name) print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

AdGroups_table = AdGroups.metadata.tables["AdGroups"] for instance in session.execute(AdGroups_table.select().where(AdGroups_table.c.CampaignId == "234505536")): print("Id: ", instance.Id) print("Name: ", instance.Name) print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Bing Ads Data

To insert Bing Ads data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Bing Ads.

new_rec = AdGroups(Id="placeholder", CampaignId="234505536") session.add(new_rec) session.commit()

Update Bing Ads Data

To update Bing Ads data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Bing Ads.

updated_rec = session.query(AdGroups).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.CampaignId = "234505536" session.commit()

Delete Bing Ads Data

To delete Bing Ads data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(AdGroups).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()

Free Trial & More Information

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