The tap-bing-ads Meltano extractor pulls data from Bing Ads that can then be sent to a destination using a loader.

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-bing-ads extractor to your project using meltano add :

    meltano add extractor tap-bing-ads
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-bing-ads requires the configuration of the following settings:

The settings for extractor tap-bing-ads that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Developer Token (developer_token) #

See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-developer-token.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-bing-ads set developer_token <developer_token>

export TAP_BING_ADS_DEVELOPER_TOKEN=<developer_token>

OAuth Client ID (oauth_client_id) #

See https://docs.microsoft.com/en-us/advertising/guides/get-started#quick-start-production.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-bing-ads set oauth_client_id <oauth_client_id>

export TAP_BING_ADS_OAUTH_CLIENT_ID=<oauth_client_id>

OAuth Client Secret (oauth_client_secret) #

See https://docs.microsoft.com/en-us/advertising/guides/get-started#quick-start-production.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-bing-ads set oauth_client_secret <oauth_client_secret>

export TAP_BING_ADS_OAUTH_CLIENT_SECRET=<oauth_client_secret>

Refresh Token (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 config or an environment variable:

meltano config tap-bing-ads set refresh_token <refresh_token>

export TAP_BING_ADS_REFRESH_TOKEN=<refresh_token>

Customer ID (customer_id) #

See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-ids.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-bing-ads set customer_id <customer_id>

export TAP_BING_ADS_CUSTOMER_ID=<customer_id>

Account ID(s) (account_ids) #

See https://docs.microsoft.com/en-us/advertising/guides/get-started#get-ids.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-bing-ads set account_ids <account_ids>

export TAP_BING_ADS_ACCOUNT_IDS=<account_ids>

Start Date (start_date) #

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 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

Require Live Connect (require_live_connect) #

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 config or an environment variable:

meltano config tap-bing-ads set require_live_connect <require_live_connect>

export TAP_BING_ADS_REQUIRE_LIVE_CONNECT=<require_live_connect>

Looking for help? #

If you're having trouble getting the tap-bing-ads extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!