# Bing Ads
The tap-bing-ads
extractor pulls data from the Bing Ads API.
- Repository: https://github.com/singer-io/tap-bing-ads
- Maintainer: Stitch
- Maintenance status: Unresponsive to community issues and contributions
- A more active fork may be available that you can use instead.
- This plugin is up for adoption!
# Getting Started
# Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
# Installation and configuration
# Using the Command Line Interface
Add the
tap-bing-ads
extractor to your project usingmeltano add
:meltano add extractor tap-bing-ads
Configure the settings below using
meltano config
.
# Using Meltano UI
Start Meltano UI using
meltano ui
:meltano ui
Open the Extractors interface at http://localhost:5000/extractors.
Click the "Add to project" button for "Bing Ads".
Configure the settings below in the "Configuration" interface that opens automatically.
# Next steps
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.
# Settings
tap-bing-ads
requires the configuration of the following settings:
- Developer Token
- OAuth Client ID
- OAuth Client Secret
- Refresh Token
- Customer ID
- Account IDs
- Start Date
- Require Live Connect
# Minimal configuration
A minimal configuration of tap-bing-ads
in your meltano.yml
project file will look like this:
plugins:
extractors:
- name: tap-bing-ads
variant: singer-io
config:
customer_id: 163875182
account_ids: 163078754
start_date: '2020-10-01T00:00:00Z'
Sensitive values are most appropriately stored in the environment or your project's .env
file:
export OAUTH_BING_ADS_DEVELOPER_TOKEN=my_developer_token
export OAUTH_BING_ADS_CLIENT_ID=my_client_id
export OAUTH_BING_ADS_CLIENT_SECRET=my_client_secret
export TAP_BING_ADS_REFRESH_TOKEN=my_refresh_token
# Developer Token
- Name:
developer_token
- Environment variable:
OAUTH_BING_ADS_DEVELOPER_TOKEN
See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-developer-token.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set developer_token <token>
export OAUTH_BING_ADS_DEVELOPER_TOKEN=<token>
# OAuth Client ID
- Name:
oauth_client_id
- Environment variable:
OAUTH_BING_ADS_CLIENT_ID
See https://docs.microsoft.com/en-us/advertising/guides/get-started#quick-start-production.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set oauth_client_id <id>
export OAUTH_BING_ADS_CLIENT_ID=<id>
# OAuth Client Secret
- Name:
oauth_client_secret
- Environment variable:
OAUTH_BING_ADS_CLIENT_SECRET
See https://docs.microsoft.com/en-us/advertising/guides/get-started#quick-start-production.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set oauth_client_secret <secret>
export OAUTH_BING_ADS_CLIENT_SECRET=<secret>
# Refresh Token
- Name:
refresh_token
- Environment variable:
TAP_BING_ADS_REFRESH_TOKEN
See https://docs.microsoft.com/en-us/advertising/guides/get-started#quick-start-production.
If you're using a Refresh Token you should not need a redirect URI in the request.
Note that you'll need to include the OAuth Scopes when requesting the token.
The recommended scopes are scope=openid%20profile%20https://ads.microsoft.com/ads.manage%20offline_access
.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set refresh_token <token>
export TAP_BING_ADS_REFRESH_TOKEN=<token>
# Customer ID
- Name:
customer_id
- Environment variable:
TAP_BING_ADS_CUSTOMER_ID
See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-ids.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set customer_id <id>
export TAP_BING_ADS_CUSTOMER_ID=<id>
# Account IDs
- Name:
account_ids
- Environment variable:
TAP_BING_ADS_ACCOUNT_IDS
See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-ids.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set account_ids <id>
export TAP_BING_ADS_ACCOUNT_IDS=<id>
# Require Live Connect
- Name:
require_live_connect
- Environment variable:
TAP_BING_REQUIRE_LIVE_CONNECT
- Default: 'True'
Note that the default is not a boolean, but a string set to 'True'. Setting the configuration to a boolean false
will work to disable this setting.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set require_live_connect false
export TAP_BING_REQUIRE_LIVE_CONNECT=false
# Start Date
- Name:
start_date
- Environment variable:
TAP_BING_ADS_START_DATE
This property determines how much historical data will be extracted.
Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
# How to use
Manage this setting using Meltano UI, meltano config
, or an environment variable:
meltano config tap-bing-ads set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_BING_ADS_START_DATE=YYYY-MM-DDTHH:MM:SSZ
# For example:
meltano config tap-bing-ads set start_date 2020-10-01T00:00:00Z
export TAP_BING_ADS_START_DATE=2020-10-01T00:00:00Z