Apple Search Ads

tap-apple-search-ads (mighty-digital variant)

The tap-apple-search-ads extractor pulls data from Apple Search 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-apple-search-ads extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-apple-search-ads
  3. Configure the tap-apple-search-ads settings using
    meltano config
    :
  4. meltano config tap-apple-search-ads set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-apple-search-ads test

Next steps

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

Capabilities

The current capabilities for tap-apple-search-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-apple-search-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 also list these settings using

meltano config
with the list subcommand:

meltano config tap-apple-search-ads 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.

Org Id (org_id)

  • Environment variable: TAP_APPLE_SEARCH_ADS_ORG_ID

Apple Search Ads Organization ID, obtained from Apple Search Ads console.


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set org_id [value]

Team Id (team_id)

  • Environment variable: TAP_APPLE_SEARCH_ADS_TEAM_ID

obtained from "Implementing OAuth for the Apple Search Ads API".


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set team_id [value]

Client Id (client_id)

  • Environment variable: TAP_APPLE_SEARCH_ADS_CLIENT_ID

obtained from "Implementing OAuth for the Apple Search Ads API".


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set client_id [value]

Private Key File (private_key_file)

  • Environment variable: TAP_APPLE_SEARCH_ADS_PRIVATE_KEY_FILE

path to the private-key.pem file obtained from "Implementing OAuth for the Apple Search Ads API".


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set private_key_file [value]

Key Id (key_id)

  • Environment variable: TAP_APPLE_SEARCH_ADS_KEY_ID

obtained from "Implementing OAuth for the Apple Search Ads API".


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set key_id [value]

Private Key Value (private_key_value)

  • Environment variable: TAP_APPLE_SEARCH_ADS_PRIVATE_KEY_VALUE

contents of the private-key.pem file as string (joined with \n character).


Configure this setting directly using the following Meltano command:

meltano config tap-apple-search-ads set private_key_value [value]

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-apple-search-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-apple-search-ads

Maintenance Status

  • Maintenance Status

Repo

https://github.com/mighty-digital/tap-apple-search-ads
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • mighty-digital

Keywords