Bing Ads

tap-bing-ads from singer-io

Advertising Platform

The tap-bing-ads 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
    :
  2. meltano add extractor tap-bing-ads
  3. Configure the tap-bing-ads settings using
    meltano config
    :
  4. meltano config tap-bing-ads set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-bing-ads test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-bing-ads may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-bing-ads settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Developer Token (developer_token)

  • Environment variable: TAP_BING_ADS_DEVELOPER_TOKEN

OAuth Client ID (oauth_client_id)

  • Environment variable: TAP_BING_ADS_OAUTH_CLIENT_ID

OAuth Client Secret (oauth_client_secret)

  • Environment variable: TAP_BING_ADS_OAUTH_CLIENT_SECRET

Refresh Token (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.

Customer ID (customer_id)

  • Environment variable: TAP_BING_ADS_CUSTOMER_ID

Account ID(s) (account_ids)

  • Environment variable: TAP_BING_ADS_ACCOUNT_IDS

Start Date (start_date)

  • Environment variable: TAP_BING_ADS_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.

Require Live Connect (require_live_connect)

  • Environment variable: TAP_BING_ADS_REQUIRE_LIVE_CONNECT
  • Default Value: 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.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add extractor tap-bing-ads

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api