# Bing Ads

The tap-bing-ads extractor pulls data from the Bing Ads API.

To learn more about tap-bing-ads, refer to the repository at https://github.com/singer-io/tap-bing-ads.

# 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

# Using the Command Line Interface

  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.

# Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
    
  2. Open the Extractors interface at http://localhost:5000/extractors.

  3. Click the "Add to project" button for "Bing Ads".

  4. Configure the settings below in the "Configuration" interface that opens automatically.

# 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

# Settings

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

# 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
    pip_url: tap-bing-ads
    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

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

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

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

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

export TAP_BING_ADS_REFRESH_TOKEN=<token>

# 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

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>

# 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