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:
Installation and configuration
-
Add the tap-apple-search-ads extractor to your
project using
:meltano add -
Configure the tap-apple-search-ads
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-apple-search-adsmeltano config tap-apple-search-ads set --interactivemeltano config tap-apple-search-ads testNext steps
Follow the remaining steps of the Getting Started guide:
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
with the meltano configlist
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.
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]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]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]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]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]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]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-73-c0c0c4){kind=icon}
-5-c0c0c4){kind=icon}
