Connect App Store Connect

This connection lets Marketing read the analytics reports that App Store Connect keeps for your apps, to show their App Store downloads and discovery numbers with the brand's other numbers. It uses a team API key that you make in App Store Connect. It is your org's or a brand's. See Connections for how connecting works in general.

Ways to connect

App Store Connect is connected with Add a key only: an API key's issuer id, key id and private key file. Apple's guide to creating API keys describes them.

Making the key

  1. Sign in to App Store Connect as the Account Holder or an Admin and open the API keys page, Users and Access > Integrations. Choose the Team Keys tab, and generate an API key.
  2. Name it so you know what it is for, and give it the Admin role to begin with (see below).
  3. Download the .p8 private key file. Apple lets you download it once. Copy the Issuer ID, shown at the top of the page, and the key's Key ID.
  4. On the Connections page, choose Add a key for App Store Connect. Give the Issuer ID and the Key ID, paste the contents of the .p8 file into Key, token or address, and press Test and save. Pasting the file's text into a one-line field is fine: GreenMind puts its line breaks back. The key is checked with Apple before it is saved.

Why Admin first

To read analytics reports, a request for them has to exist for each app, and Apple lets only an Admin key make that request. GreenMind makes it once, on the first import. After the request exists, a key with the Sales and Reports role can read the reports. So connect with an Admin key; once the first reports have arrived, you may make a Sales and Reports key, connect it with Add another key (which asks for the new key's ids; Reconnect keeps the old ones), and delete the Admin key in App Store Connect.

The first reports arrive a day or two after the request is made.

Permissions

There are no scopes. What the key may do is the role you give it in App Store Connect.

After connecting

Say which app it reports on under Numbers, Imports, in Store numbers: choose Use a connection, pick this connection and give the Apple ID of the app: the number App Store Connect shows for the app under App Information, not its bundle id.

If it goes wrong

  • App Store Connect refused the API key. The issuer id, key id or private key do not belong together, the key was revoked, or its role is too low. Check them against the Integrations page.
  • That is not an App Store Connect private key. The text pasted is not the whole .p8 file, including its BEGIN and END lines.
  • The issuer and key ids are not set. Both are needed to sign in.
  • No numbers yet. Apple has not produced the first reports. They take a day or two after the request is made, and a Sales and Reports key cannot make the request.