Apple AppStore

tap-appstore (automattic variant)🥈

Management API for Apple Apps

The tap-appstore extractor pulls data from Apple AppStore that can then be sent to a destination using a loader.

Alternate Implementations

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

Next steps

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

Capabilities

The current capabilities for tap-appstore 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-appstore 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-appstore 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.

Issuer ID (issuer_id)

  • Environment variable: TAP_APPSTORE_ISSUER_ID

Your issuer ID from the API Keys page in App Store Connect, for example, 57246542-96fe-1a63-e053-0824d011072a


Configure this setting directly using the following Meltano command:

meltano config tap-appstore set issuer_id [value]

Key File (key_file)

  • Environment variable: TAP_APPSTORE_KEY_FILE

Appstore key file.


Configure this setting directly using the following Meltano command:

meltano config tap-appstore set key_file [value]

Key ID (key_id)

  • Environment variable: TAP_APPSTORE_KEY_ID

Your private key ID from App Store Connect, for example, 2X9R4HXF34.


Configure this setting directly using the following Meltano command:

meltano config tap-appstore set key_id [value]

Start Date (start_date)

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


Configure this setting directly using the following Meltano command:

meltano config tap-appstore set start_date [value]

Vendor (vendor)

  • Environment variable: TAP_APPSTORE_VENDOR

Configure this setting directly using the following Meltano command:

meltano config tap-appstore set vendor [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-appstore 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-appstore

Maintenance Status

  • Maintenance Status

Repo

https://github.com/Automattic/tap-appstore
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Automattic

Keywords

  • api