App Store Connect を Open Flow に接続
Give AI an app identifier to organize build status and review feedback before you make a release or testing decision.
毎月 20,000 回のアプリ呼び出しが無料(有料サービスは別途課金)
アプリの説明と操作の詳細は英語で表示されます。
できること
App Store Connect holds app, build, TestFlight, and review records alongside release-management resources. The workflows here focus on build checks, customer feedback, and tester instructions.
App and Build Records
Find apps and read build, prerelease version, and review information.
TestFlight Preparation
Review groups and testers, publish notes, invite testers, and assign builds to groups.
Customer Review Reading
Read App Store customer reviews and their developer responses.
すべての操作
List Apps
List the apps the API key can see, optionally filtered by bundle identifier, name, or SKU.
app_store_connect.list_appsGet App
Read one app record by its App Store Connect identifier.
app_store_connect.get_appList Builds
List builds uploaded for one app, with the prerelease version each build belongs to. Filter by version, platform, processing state, or TestFlight review state.
app_store_connect.list_buildsGet Build
Read one build together with its prerelease version, its TestFlight review submission, and the app it belongs to.
app_store_connect.get_buildList Pre Release Versions
List the prerelease versions of one app, which group its TestFlight builds by marketing version.
app_store_connect.list_pre_release_versionsList Beta Groups
List the TestFlight groups of one app, including the public invitation link of each group.
app_store_connect.list_beta_groupsCreate Beta Group
Create a TestFlight group for an app, optionally enabling its public invitation link.
app_store_connect.create_beta_groupDelete Beta Group
Delete a TestFlight group. Testers who only belonged to that group lose access to its builds.
app_store_connect.delete_beta_groupList Beta Testers
List TestFlight testers, optionally narrowed to one app, group, or build.
app_store_connect.list_beta_testersCreate Beta Tester
Invite a TestFlight tester by email. App Store Connect only creates a tester that is assigned to something, so pass at least one of betaGroupIds or buildIds.
app_store_connect.create_beta_testerDelete Beta Tester
Remove a TestFlight tester from the team, revoking their access to every build and group.
app_store_connect.delete_beta_testerAdd Beta Testers To Group
Add existing TestFlight testers to one group so they receive the builds that group can install.
app_store_connect.add_beta_testers_to_groupRemove Beta Testers From Group
Remove testers from one TestFlight group. The testers stay on the team and keep access through their other groups.
app_store_connect.remove_beta_testers_from_groupAdd Build To Beta Groups
Make one build available to TestFlight groups so their testers can install it.
app_store_connect.add_build_to_beta_groupsSubmit Build For Beta Review
Submit a build for TestFlight beta review, which external groups require before they can install it.
app_store_connect.submit_build_for_beta_reviewUpdate Build Test Notes
Set the "What to Test" notes a build shows testers in one locale. Updates the existing notes for that locale, or creates them when the locale has none yet.
app_store_connect.update_build_test_notesList App Store Versions
List the App Store versions of one app, with the review and release state of each version.
app_store_connect.list_app_store_versionsGet App Store Version
Read one App Store version by its App Store Connect identifier.
app_store_connect.get_app_store_versionList Customer Reviews
List the App Store reviews of one app together with the developer response published for each review.
app_store_connect.list_customer_reviewsGet Customer Review
Read one App Store review together with the developer response published for it.
app_store_connect.get_customer_reviewRespond To Customer Review
Publish a developer response to an App Store review. App Store Connect treats this as an upsert: an existing response for the same review is replaced, and publication is asynchronous.
app_store_connect.respond_to_customer_reviewDelete Customer Review Response
Remove a published developer response from an App Store review.
app_store_connect.delete_customer_review_responseList Users
List the members of the App Store Connect team, with the roles granted to each of them.
app_store_connect.list_usersGet User
Read one App Store Connect team member by identifier.
app_store_connect.get_userGet App Price Schedule
Read the price schedule of an app, including the base territory its automatic prices derive from. Returns null when App Store Connect has no price schedule for the app yet. Use list_app_price_schedule_manual_prices and list_app_price_schedule_automatic_prices for the individual prices.
app_store_connect.get_app_price_scheduleCreate App Price Schedule
Set the price schedule of an app: the base territory plus the manual prices, each a price point (which already encodes its territory) with an optional date range. App Store Connect derives the prices of every other territory from the base territory price. The new schedule replaces the current prices and any scheduled price changes of the app. Find price point identifiers with list_app_price_points.
app_store_connect.create_app_price_scheduleList App Price Schedule Manual Prices
List the manual prices of a price schedule, each with the price point it uses, the territory it applies to and the customer price and proceeds of that price point.
app_store_connect.list_app_price_schedule_manual_pricesList App Price Schedule Automatic Prices
List the automatic prices of a price schedule, which App Store Connect derives from the base territory price for every territory without a manual price. Each entry carries its price point, territory, customer price and proceeds.
app_store_connect.list_app_price_schedule_automatic_pricesGet App Price Schedule Base Territory
Read the base territory of a price schedule, the territory whose price the automatic prices of the other territories are derived from.
app_store_connect.get_app_price_schedule_base_territoryList App Price Points
List the price points an app can be sold at, optionally narrowed to some territories. Each price point carries the customer price and developer proceeds in the territory currency; pass its identifier to create_app_price_schedule.
app_store_connect.list_app_price_pointsGet App Price Point
Read one price point by its App Store Connect identifier, including the territory it belongs to.
app_store_connect.get_app_price_pointList App Price Point Equalizations
List the price points in other territories that App Store Connect considers equivalent to one price point, optionally narrowed to some territories. Use it to pick matching manual prices across territories.
app_store_connect.list_app_price_point_equalizationsGet App Availability
Read the availability configuration of an app, which says whether it is automatically offered in new territories. Returns null when App Store Connect has no availability record for the app yet. Use list_territory_availabilities for the per-territory settings.
app_store_connect.get_app_availabilityCreate App Availability
Set the territory availability of an app: whether it is offered in new territories automatically, and for each listed territory whether it is available, its release date and whether pre-orders are enabled. The new configuration replaces the current availability of the app in every territory, so list every territory the app should stay available in.
app_store_connect.create_app_availabilityList Territory Availabilities
List the per-territory availability of an app availability configuration: whether the app is on sale in each territory, its release date, pre-order settings and the content statuses that explain why it is or is not available.
app_store_connect.list_territory_availabilitiesUpdate Territory Availability
Change the availability of an app in one territory: toggle whether it is available, set or clear its release date, or enable pre-orders. Pass at least one field; the others keep their current values.
app_store_connect.update_territory_availabilityCreate End App Availability Pre Order
End the pre-order of an app in the given territories and release it there immediately. This is how a pre-order for the whole app is ended: pass the territory availabilities of every territory the app is on pre-order in. The pre-order cannot be resumed afterwards.
app_store_connect.create_end_app_availability_pre_orderList Webhooks
List the webhooks registered on one app, with the URL, enabled state, and subscribed event types of each.
app_store_connect.list_webhooksGet Webhook
Read one webhook by its App Store Connect identifier.
app_store_connect.get_webhookCreate Webhook
Register a webhook on an app so App Store Connect posts a signed notification to the URL whenever one of the chosen events happens. Use ping_webhook afterwards to test the endpoint.
app_store_connect.create_webhookUpdate Webhook
Change the name, URL, secret, event types, or enabled state of a webhook. Each given field replaces the current value; eventTypes replaces the whole list.
app_store_connect.update_webhookDelete Webhook
Delete a webhook. App Store Connect stops sending notifications to its URL and its delivery history is no longer reachable.
app_store_connect.delete_webhookList Webhook Deliveries
List the delivery attempts of one webhook, newest first as App Store Connect orders them, with the event each attempt carried and the response the endpoint returned. Filter by delivery state or creation time to find failed deliveries to resend.
app_store_connect.list_webhook_deliveriesRedeliver Webhook Delivery
Send the event of an earlier delivery again, for example after the endpoint was down. App Store Connect creates a new delivery marked as a redelivery; the original delivery record is kept.
app_store_connect.redeliver_webhook_deliveryPing Webhook
Send a test ping notification to a webhook so the endpoint and its signature check can be verified. The ping shows up in the webhook deliveries with ping set to true.
app_store_connect.ping_webhookList Bundle Ids
List the bundle IDs (App IDs) registered with the team, optionally filtered by identifier, name, platform, or seed ID.
app_store_connect.list_bundle_idsGet Bundle Id
Read one bundle ID record by its App Store Connect identifier.
app_store_connect.get_bundle_idCreate Bundle Id
Register a new bundle ID (App ID) with the team. Capabilities are added afterwards with enable_bundle_id_capability.
app_store_connect.create_bundle_idUpdate Bundle Id
Rename a bundle ID. The name is the only attribute App Store Connect lets you change; the identifier string and platform are fixed once registered.
app_store_connect.update_bundle_idDelete Bundle Id
Delete a bundle ID from the team. App Store Connect refuses to delete a bundle ID that an app record still uses.
app_store_connect.delete_bundle_idList Bundle Id Profiles
List the provisioning profiles that were created for one bundle ID.
app_store_connect.list_bundle_id_profilesGet Bundle Id App
Read the App Store Connect app that uses one bundle ID. Returns null when no app has been created for the bundle ID yet.
app_store_connect.get_bundle_id_appList Bundle Id Capabilities
List the capabilities enabled on one bundle ID, with their configured settings.
app_store_connect.list_bundle_id_capabilitiesEnable Bundle Id Capability
Enable a capability such as push notifications or associated domains on a bundle ID. Provisioning profiles created for the bundle ID before the change may need to be regenerated to carry the new entitlement.
app_store_connect.enable_bundle_id_capabilityUpdate Bundle Id Capability
Replace the configuration of a capability that is already enabled on a bundle ID, for example the iCloud version or data protection level. Provide at least one of capabilityType or settings; the settings given replace the current ones.
app_store_connect.update_bundle_id_capabilityDisable Bundle Id Capability
Disable a capability on a bundle ID and discard its configuration. Provisioning profiles that relied on the capability become invalid.
app_store_connect.disable_bundle_id_capabilityList Certificates
List the signing certificates of the team, including their base64 DER content, optionally filtered by type, display name, or serial number.
app_store_connect.list_certificatesGet Certificate
Read one certificate by its App Store Connect identifier, including its base64 DER content.
app_store_connect.get_certificateCreate Certificate
Issue a new signing certificate from a certificate signing request (CSR). Apple Pay and pass type certificates also take the merchant ID or pass type ID they belong to. Developer ID certificates for macOS can only be created in the Apple Developer website or Xcode, and Apple caps how many certificates of each type a team may hold.
app_store_connect.create_certificateUpdate Certificate
Activate or deactivate a certificate. App Store Connect only exposes the activation state, which applies to Apple Pay payment processing certificates; a deactivated certificate stops being used for payment processing until it is activated again.
app_store_connect.update_certificateRevoke Certificate
Revoke a certificate that was lost, stolen, compromised, or is expiring. Revocation is permanent and cannot be undone: apps signed with the certificate can no longer be re-signed with it, every provisioning profile that contains it becomes invalid, and Developer ID or Apple Pay certificates may need Apple to restore service. Issue a replacement with create_certificate first when the certificate is still in use.
app_store_connect.revoke_certificateList Profiles
List the provisioning profiles of the team, including their base64 content, optionally filtered by name, profile type, or validity state.
app_store_connect.list_profilesGet Profile
Read one provisioning profile by its App Store Connect identifier, including its base64 content.
app_store_connect.get_profileCreate Profile
Create a provisioning profile for one bundle ID from the given certificates and, for development and ad hoc profiles, the devices allowed to install the app. App Store and in-house profile types take no devices.
app_store_connect.create_profileDelete Profile
Delete a provisioning profile so it can no longer be downloaded or used to sign new builds. Create a replacement with create_profile when the bundle ID still needs one.
app_store_connect.delete_profileList Profile Certificates
List the certificates embedded in one provisioning profile.
app_store_connect.list_profile_certificatesList Profile Devices
List the devices a development or ad hoc provisioning profile allows.
app_store_connect.list_profile_devicesGet Profile Bundle Id
Read the bundle ID a provisioning profile was created for.
app_store_connect.get_profile_bundle_idList Devices
List the devices registered with the team, optionally filtered by name, platform, UDID, or status.
app_store_connect.list_devicesGet Device
Read one registered device by its App Store Connect identifier.
app_store_connect.get_deviceRegister Device
Register a device with the team so development and ad hoc profiles can include it. Apple limits how many devices a team registers per membership year, and registered devices can only be removed in the Apple Developer website; use update_device to disable one instead.
app_store_connect.register_deviceUpdate Device
Rename a registered device or change its status. Provide at least one of name or status. Disabling a device invalidates the development and ad hoc profiles that include it, while the device keeps counting toward the yearly device limit; re-enabling it keeps the same record.
app_store_connect.update_deviceList Merchant Ids
List the Apple Pay merchant IDs registered with the team, optionally filtered by name or identifier.
app_store_connect.list_merchant_idsGet Merchant Id
Read one Apple Pay merchant ID record by its App Store Connect identifier.
app_store_connect.get_merchant_idCreate Merchant Id
Register an Apple Pay merchant ID with the team. Payment processing and merchant identity certificates are issued for it afterwards with create_certificate.
app_store_connect.create_merchant_idUpdate Merchant Id
Rename an Apple Pay merchant ID. The name is the only attribute App Store Connect lets you change.
app_store_connect.update_merchant_idDelete Merchant Id
Delete an Apple Pay merchant ID from the team. Apple Pay transactions and certificates that reference it stop working.
app_store_connect.delete_merchant_idList Merchant Id Certificates
List the Apple Pay certificates issued for one merchant ID, optionally filtered by type, display name, or serial number.
app_store_connect.list_merchant_id_certificatesList Pass Type Ids
List the Wallet pass type IDs registered with the team, optionally filtered by name or identifier.
app_store_connect.list_pass_type_idsGet Pass Type Id
Read one Wallet pass type ID record by its App Store Connect identifier.
app_store_connect.get_pass_type_idCreate Pass Type Id
Register a Wallet pass type ID with the team. Pass signing certificates are issued for it afterwards with create_certificate.
app_store_connect.create_pass_type_idUpdate Pass Type Id
Rename a Wallet pass type ID. The name is the only attribute App Store Connect lets you change.
app_store_connect.update_pass_type_idDelete Pass Type Id
Delete a Wallet pass type ID from the team. Passes signed for it can no longer be updated and its certificates stop working.
app_store_connect.delete_pass_type_idList Pass Type Id Certificates
List the pass signing certificates issued for one pass type ID, optionally filtered by type, display name, or serial number.
app_store_connect.list_pass_type_id_certificatesUpdate Build
Change the TestFlight flags of one build: expire it so testers can no longer install it, or record whether it uses non-exempt encryption. Expiring a build cannot be undone. Pass at least one field.
app_store_connect.update_buildList Build Individual Testers
List the TestFlight testers who were assigned one build individually, outside of any group.
app_store_connect.list_build_individual_testersAdd Individual Testers To Build
Assign existing TestFlight testers to one build individually so they can install it without belonging to a group.
app_store_connect.add_individual_testers_to_buildRemove Individual Testers From Build
Remove the individual assignment of TestFlight testers from one build. Testers keep access through any group that has the build.
app_store_connect.remove_individual_testers_from_buildRemove Build From Beta Groups
Withdraw one build from TestFlight groups so their testers can no longer install it.
app_store_connect.remove_build_from_beta_groupsList Build Beta Groups
List the TestFlight groups that can install one build.
app_store_connect.list_build_beta_groupsGet Build Beta Detail
Read the TestFlight distribution details of one build: its internal and external testing states and whether testers are notified automatically.
app_store_connect.get_build_beta_detailUpdate Build Beta Detail
Turn automatic tester notifications on or off for one build. The build beta detail identifier comes from get_build_beta_detail.
app_store_connect.update_build_beta_detailNotify Build Testers
Send the TestFlight availability notification for one build to every tester who can install it. The notification cannot be recalled, so use it only when automatic notifications were off.
app_store_connect.notify_build_testersList Beta Build Localizations
List the "What to Test" notes of one build, one record per locale, optionally narrowed to a single locale.
app_store_connect.list_beta_build_localizationsGet Beta Build Localization
Read the "What to Test" notes record of one build and locale by its identifier.
app_store_connect.get_beta_build_localizationCreate Beta Build Localization
Create the "What to Test" notes of one build for a locale that has none yet. App Store Connect rejects a second record for the same locale; use update_build_test_notes to change existing notes.
app_store_connect.create_beta_build_localizationUpdate Beta Build Localization
Replace the "What to Test" notes of one existing build localization. The previous text is overwritten.
app_store_connect.update_beta_build_localizationDelete Beta Build Localization
Delete the "What to Test" notes of one build in one locale. Testers in that locale fall back to the notes of the primary locale.
app_store_connect.delete_beta_build_localizationGet Beta App Review Detail
Read the contact person, demo account, and notes Apple uses when reviewing an app for TestFlight external testing.
app_store_connect.get_beta_app_review_detailUpdate Beta App Review Detail
Change the contact person, demo account, or notes Apple uses when reviewing an app for TestFlight. Each field given replaces the stored value; pass at least one. The identifier comes from get_beta_app_review_detail.
app_store_connect.update_beta_app_review_detailList Beta App Localizations
List the TestFlight test information of one app, one record per locale, optionally narrowed to a single locale.
app_store_connect.list_beta_app_localizationsGet Beta App Localization
Read the TestFlight test information of one app and locale by its identifier.
app_store_connect.get_beta_app_localizationCreate Beta App Localization
Create the TestFlight test information of an app for a locale that has none yet: the description, feedback email, and URLs testers see in TestFlight.
app_store_connect.create_beta_app_localizationUpdate Beta App Localization
Change the TestFlight test information of one app localization. Each field given replaces the stored value; pass at least one.
app_store_connect.update_beta_app_localizationDelete Beta App Localization
Delete the TestFlight test information of an app in one locale. Testers in that locale fall back to the primary locale.
app_store_connect.delete_beta_app_localizationGet Beta License Agreement
Read the license agreement TestFlight testers of an app must accept.
app_store_connect.get_beta_license_agreementUpdate Beta License Agreement
Replace the license agreement text TestFlight testers of an app must accept. The identifier comes from get_beta_license_agreement.
app_store_connect.update_beta_license_agreementResend Beta Tester Invitation
Send the TestFlight invitation email again to a tester who has not accepted the invitation for one app.
app_store_connect.resend_beta_tester_invitationGet Beta Group
Read one TestFlight group by its identifier, including its public link settings.
app_store_connect.get_beta_groupUpdate Beta Group
Change the name, public link, feedback, or Apple silicon and Apple Vision availability settings of one TestFlight group. Each field given replaces the stored value; pass at least one.
app_store_connect.update_beta_groupList Beta Group Builds
List the builds one TestFlight group can install, with the prerelease version each build belongs to.
app_store_connect.list_beta_group_buildsAdd Builds To Beta Group
Make several builds available to one TestFlight group so its testers can install them.
app_store_connect.add_builds_to_beta_groupRemove Builds From Beta Group
Withdraw several builds from one TestFlight group so its testers can no longer install them.
app_store_connect.remove_builds_from_beta_groupGet Beta Tester
Read one TestFlight tester by its identifier, including the invitation state and the devices the app is installed on.
app_store_connect.get_beta_testerList Beta Tester Apps
List the apps one TestFlight tester has access to.
app_store_connect.list_beta_tester_appsRemove Beta Tester From Apps
Revoke a TestFlight tester's access to specific apps, removing them from every group and build of those apps while keeping them on the team.
app_store_connect.remove_beta_tester_from_appsList Beta Tester Beta Groups
List the TestFlight groups one tester belongs to.
app_store_connect.list_beta_tester_beta_groupsGet Pre Release Version
Read one prerelease version by its identifier.
app_store_connect.get_pre_release_versionList Beta App Review Submissions
List the TestFlight beta review submissions of one build, optionally narrowed to one review state.
app_store_connect.list_beta_app_review_submissionsGet Beta App Review Submission
Read one TestFlight beta review submission by its identifier.
app_store_connect.get_beta_app_review_submissionCreate App Store Version
Create a new App Store version for an app on one platform. The version starts in PREPARE_FOR_SUBMISSION and can be deleted again until it is submitted for review.
app_store_connect.create_app_store_versionUpdate App Store Version
Change the version string, copyright, review or release settings, or attached build of an App Store version. Each given field overwrites the current value; pass null for copyright or earliestReleaseDate to clear them.
app_store_connect.update_app_store_versionDelete App Store Version
Delete an App Store version that has not been submitted yet, together with its localizations and review information.
app_store_connect.delete_app_store_versionSet App Store Version Build
Select the build an App Store version submits for review, replacing any build selected before. Pass null as buildId to detach the current build.
app_store_connect.set_app_store_version_buildGet App Store Version Build
Read the build currently attached to an App Store version, or null when no build has been selected.
app_store_connect.get_app_store_version_buildList App Store Version Localizations
List the localized App Store metadata (description, keywords, release notes, URLs) of one App Store version, optionally narrowed to specific locales.
app_store_connect.list_app_store_version_localizationsGet App Store Version Localization
Read the localized App Store metadata of one version in one locale.
app_store_connect.get_app_store_version_localizationCreate App Store Version Localization
Add App Store metadata for one locale to an App Store version. The locale must be enabled for the app and must not already have a localization on this version.
app_store_connect.create_app_store_version_localizationUpdate App Store Version Localization
Overwrite the localized App Store metadata of one version in one locale. Only the given fields change; pass null to clear a field.
app_store_connect.update_app_store_version_localizationDelete App Store Version Localization
Remove the App Store metadata of one locale from an App Store version, including its screenshots and previews.
app_store_connect.delete_app_store_version_localizationGet App Store Version Phased Release
Read the phased release configuration of an App Store version, or null when phased release is not configured for it.
app_store_connect.get_app_store_version_phased_releaseCreate App Store Version Phased Release
Enable phased release for an App Store version so an approved update rolls out to automatic-update users over seven days. Can be removed again with delete_app_store_version_phased_release before the version is released.
app_store_connect.create_app_store_version_phased_releaseUpdate App Store Version Phased Release
Pause, resume, or complete the phased rollout of a released version. COMPLETE releases the version to every user at once and cannot be undone.
app_store_connect.update_app_store_version_phased_releaseDelete App Store Version Phased Release
Turn off phased release for an App Store version so the approved update reaches every user at once.
app_store_connect.delete_app_store_version_phased_releaseRelease App Store Version
Release an approved App Store version that is waiting in PENDING_DEVELOPER_RELEASE to the App Store. The release starts immediately and cannot be undone.
app_store_connect.release_app_store_versionGet App Store Review Detail
Read the App Review contact details, demo account, and notes attached to an App Store version, or null when none were entered yet.
app_store_connect.get_app_store_review_detailCreate App Store Review Detail
Enter the App Review contact details, demo account, and notes for an App Store version that has none yet.
app_store_connect.create_app_store_review_detailUpdate App Store Review Detail
Overwrite the App Review contact details, demo account, or notes of an App Store version. Only the given fields change; pass null to clear a text field.
app_store_connect.update_app_store_review_detailList Review Submissions
List the review submissions of one app, with the App Store version each submission carries. Filter by platform or review state.
app_store_connect.list_review_submissionsGet Review Submission
Read one review submission with its state and the App Store version it carries.
app_store_connect.get_review_submissionCreate Review Submission
Start a new review submission for an app on one platform. Add items with add_review_submission_item, then send it with submit_review_submission. An app can have only one open submission per platform.
app_store_connect.create_review_submissionSubmit Review Submission
Send a prepared review submission and all of its items to App Review. The submission moves to WAITING_FOR_REVIEW and can only be taken back with cancel_review_submission.
app_store_connect.submit_review_submissionCancel Review Submission
Cancel a review submission, removing it from the App Review queue. Its items return to their previous state and a new submission is needed to submit them again.
app_store_connect.cancel_review_submissionList Review Submission Items
List the items in a review submission, each naming the App Store version, custom product page version, experiment, or in-app event it reviews.
app_store_connect.list_review_submission_itemsAdd Review Submission Item
Add one record to an open review submission. Give exactly one of appStoreVersionId, appCustomProductPageVersionId, appStoreVersionExperimentId, appStoreVersionExperimentV2Id, or appEventId. The item can be removed again with delete_review_submission_item before the submission is sent.
app_store_connect.add_review_submission_itemUpdate Review Submission Item
Mark a review submission item as resolved after fixing the issues App Review raised, or mark it as removed so the submission continues without it.
app_store_connect.update_review_submission_itemDelete Review Submission Item
Delete an item from a review submission that has not been sent to App Review yet.
app_store_connect.delete_review_submission_itemUpdate App
Update app-level settings such as the primary locale, third-party content rights declaration, server notification URLs, or accessibility URL. Overwrites the given attributes; pass null for a URL to clear it. Pass at least one attribute.
app_store_connect.update_appList App Infos
List the app info records of an app, each with its review state, derived age ratings, and the identifiers of its App Store categories. An app usually has one editable record plus the record of the version on the App Store.
app_store_connect.list_app_infosGet App Info
Read one app info record with its review state, derived age ratings, and App Store category identifiers.
app_store_connect.get_app_infoUpdate App Info
Set the App Store categories of an app info record. Each given category replaces the current one; subcategories only apply when the matching category is Games or Stickers. Pass at least one category. Use list_app_categories to find identifiers.
app_store_connect.update_app_infoList App Info Localizations
List the localized names, subtitles, and privacy URLs of an app info record, optionally narrowed to some locales.
app_store_connect.list_app_info_localizationsGet App Info Localization
Read one app info localization by its identifier.
app_store_connect.get_app_info_localizationCreate App Info Localization
Add a locale to an app info record with the app name and optional subtitle and privacy URLs shown in that locale. App Store Connect rejects a locale the record already has.
app_store_connect.create_app_info_localizationUpdate App Info Localization
Change the name, subtitle, or privacy URLs of an app info localization. Overwrites the given fields; pass null to clear a subtitle, URL, or privacy text. Pass at least one field.
app_store_connect.update_app_info_localizationDelete App Info Localization
Remove a locale from an app info record. The app stops being listed in that language once the change is submitted.
app_store_connect.delete_app_info_localizationList App Categories
List App Store categories with their platforms, parent, and subcategory identifiers. Filter by platform or list only top-level categories or only subcategories.
app_store_connect.list_app_categoriesGet App Category
Read one App Store category with its platforms, parent category, and subcategory identifiers.
app_store_connect.get_app_categoryGet Age Rating Declaration
Read the age rating questionnaire answers attached to an app info record, including any manual rating overrides.
app_store_connect.get_age_rating_declarationUpdate Age Rating Declaration
Answer or change questions of the age rating questionnaire. Only the given answers are overwritten; App Store Connect recalculates the derived age ratings. Pass at least one answer.
app_store_connect.update_age_rating_declarationList Accessibility Declarations
List the accessibility declarations (Accessibility Nutrition Labels) of an app, optionally filtered by device family or publication state.
app_store_connect.list_accessibility_declarationsGet Accessibility Declaration
Read one accessibility declaration by its identifier.
app_store_connect.get_accessibility_declarationCreate Accessibility Declaration
Create a draft accessibility declaration for one device family of an app. The draft is not shown on the App Store until update_accessibility_declaration publishes it.
app_store_connect.create_accessibility_declarationUpdate Accessibility Declaration
Change the supported accessibility features of a declaration, or publish it by passing publish: true, which replaces the currently published declaration for that device family. Pass at least one field.
app_store_connect.update_accessibility_declarationDelete Accessibility Declaration
Delete an accessibility declaration.
app_store_connect.delete_accessibility_declarationList App Encryption Declarations
List the export compliance (encryption) declarations of an app with their review state and compliance code, optionally filtered by platform or by the builds they cover.
app_store_connect.list_app_encryption_declarationsGet App Encryption Declaration
Read one export compliance (encryption) declaration by its identifier.
app_store_connect.get_app_encryption_declarationCreate App Encryption Declaration
Create an export compliance declaration for an app that uses non-exempt encryption. App Store Connect reviews it and assigns a compliance code; the declaration cannot be edited afterwards, only replaced by a new one. Supporting documents must be uploaded separately.
app_store_connect.create_app_encryption_declarationGet End User License Agreement
Read the custom end user license agreement of an app together with the territories it applies in. Returns null when the app uses Apple's standard EULA everywhere.
app_store_connect.get_end_user_license_agreementCreate End User License Agreement
Attach a custom end user license agreement to an app for the given territories. Apple's standard EULA keeps applying elsewhere. App Store Connect rejects a second agreement for the same app.
app_store_connect.create_end_user_license_agreementUpdate End User License Agreement
Replace the text of a custom end user license agreement or the full set of territories it applies in. Pass at least one of agreementText or territoryIds.
app_store_connect.update_end_user_license_agreementDelete End User License Agreement
Remove the custom end user license agreement of an app so Apple's standard EULA applies in every territory.
app_store_connect.delete_end_user_license_agreementList Territories
List every App Store territory with its currency. Territory identifiers are used for license agreements, availability, and pricing.
app_store_connect.list_territoriesList App Tags
List the tags App Store Connect assigned to an app for App Store discovery, optionally only those shown or hidden on the App Store.
app_store_connect.list_app_tagsList Android To Ios App Mapping Details
List the Android app mappings of an app, which link an Android package to this app for Android to iPhone migration.
app_store_connect.list_android_to_ios_app_mapping_detailsGet Android To Ios App Mapping Detail
Read one Android app mapping by its identifier.
app_store_connect.get_android_to_ios_app_mapping_detailCreate Android To Ios App Mapping Detail
Map an Android app to this app by its package name and signing certificate fingerprints, so Android users migrating to iPhone are offered this app.
app_store_connect.create_android_to_ios_app_mapping_detailUpdate Android To Ios App Mapping Detail
Change the package name or replace the full list of signing certificate fingerprints of an Android app mapping. Pass at least one field.
app_store_connect.update_android_to_ios_app_mapping_detailDelete Android To Ios App Mapping Detail
Delete an Android app mapping.
app_store_connect.delete_android_to_ios_app_mapping_detailList Ci Products
List the Xcode Cloud products of the team, optionally narrowed to one app or to app or framework products. A product holds the workflows and build runs of one app or framework.
app_store_connect.list_ci_productsGet Ci Product
Read one Xcode Cloud product by its App Store Connect identifier.
app_store_connect.get_ci_productDelete Ci Product
Delete an Xcode Cloud product, which removes every workflow and build history of that app or framework from Xcode Cloud.
app_store_connect.delete_ci_productList Ci Product Workflows
List the workflows of one Xcode Cloud product.
app_store_connect.list_ci_product_workflowsList Ci Product Build Runs
List the build runs of one Xcode Cloud product across all of its workflows, optionally narrowed to the run that produced one build.
app_store_connect.list_ci_product_build_runsList Ci Product Primary Repositories
List the primary repositories of one Xcode Cloud product, the repositories that hold the project or package its workflows build.
app_store_connect.list_ci_product_primary_repositoriesList Ci Product Additional Repositories
List the additional repositories of one Xcode Cloud product, such as Swift package dependencies Xcode Cloud has been granted access to.
app_store_connect.list_ci_product_additional_repositoriesGet Ci Workflow
Read one Xcode Cloud workflow with its start conditions, actions, and the product, repository, Xcode version, and macOS version it uses.
app_store_connect.get_ci_workflowCreate Ci Workflow
Create an Xcode Cloud workflow for a product. Give it at least one action and, for automatic builds, one or more start conditions; without start conditions it can only be started manually.
app_store_connect.create_ci_workflowUpdate Ci Workflow
Change an Xcode Cloud workflow. Every field given replaces the current value; a start condition or the actions array is replaced as a whole, so pass the complete new object. Give at least one field to change.
app_store_connect.update_ci_workflowDelete Ci Workflow
Delete an Xcode Cloud workflow together with its build history. Builds already delivered to TestFlight or App Store Connect are kept.
app_store_connect.delete_ci_workflowList Ci Workflow Build Runs
List the build runs of one Xcode Cloud workflow, optionally narrowed to the run that produced one build.
app_store_connect.list_ci_workflow_build_runsGet Ci Workflow Repository
Read the source repository an Xcode Cloud workflow builds from.
app_store_connect.get_ci_workflow_repositoryGet Ci Build Run
Read one Xcode Cloud build run, including its progress, completion status, issue counts, and the commit it built. Poll it to follow a run started with start_ci_build_run.
app_store_connect.get_ci_build_runStart Ci Build Run
Start an Xcode Cloud build run for a workflow. Pass the Git reference of the branch or tag to build, or the pull request to build; the run is queued and progresses asynchronously, so read it back with get_ci_build_run.
app_store_connect.start_ci_build_runList Ci Build Run Actions
List the actions (build, analyze, test, archive) of one build run with the progress and outcome of each.
app_store_connect.list_ci_build_run_actionsList Ci Build Run Builds
List the App Store Connect builds an Xcode Cloud build run delivered, with the prerelease version each build belongs to. Use it to find the build to distribute after an archive action.
app_store_connect.list_ci_build_run_buildsGet Ci Build Action
Read one action of a build run, with its progress, outcome, and issue counts.
app_store_connect.get_ci_build_actionList Ci Build Action Artifacts
List the artifacts a build action produced, such as archives, log bundles, and result bundles, each with a time-limited download URL.
app_store_connect.list_ci_build_action_artifactsList Ci Build Action Issues
List the errors, warnings, analyzer warnings, and test failures a build action reported.
app_store_connect.list_ci_build_action_issuesList Ci Build Action Test Results
List the per-test results of a test action, with the outcome on each destination.
app_store_connect.list_ci_build_action_test_resultsGet Ci Build Action Build Run
Read the build run a build action belongs to.
app_store_connect.get_ci_build_action_build_runGet Ci Artifact
Read one build artifact, including a fresh time-limited download URL for its file.
app_store_connect.get_ci_artifactGet Ci Issue
Read one issue a build action reported, with the file and line it points at.
app_store_connect.get_ci_issueGet Ci Test Result
Read the result of one test method across the destinations it ran on.
app_store_connect.get_ci_test_resultList Ci Mac Os Versions
List the macOS versions Xcode Cloud can build on.
app_store_connect.list_ci_mac_os_versionsGet Ci Mac Os Version
Read one macOS version available in Xcode Cloud.
app_store_connect.get_ci_mac_os_versionList Ci Mac Os Version Xcode Versions
List the Xcode versions that can run on one macOS version in Xcode Cloud.
app_store_connect.list_ci_mac_os_version_xcode_versionsList Ci Xcode Versions
List the Xcode versions Xcode Cloud can build with, each with the simulators and Macs available for tests.
app_store_connect.list_ci_xcode_versionsGet Ci Xcode Version
Read one Xcode version available in Xcode Cloud, with the simulators and Macs available for tests.
app_store_connect.get_ci_xcode_versionList Ci Xcode Version Mac Os Versions
List the macOS versions one Xcode version can run on in Xcode Cloud.
app_store_connect.list_ci_xcode_version_mac_os_versionsList Scm Providers
List the source control providers (GitHub, GitLab, Bitbucket) connected to Xcode Cloud for the team.
app_store_connect.list_scm_providersGet Scm Provider
Read one source control provider connected to Xcode Cloud.
app_store_connect.get_scm_providerList Scm Provider Repositories
List the repositories Xcode Cloud can access on one source control provider.
app_store_connect.list_scm_provider_repositoriesList Scm Repositories
List every source repository Xcode Cloud can access across all connected providers, optionally narrowed to specific repository identifiers.
app_store_connect.list_scm_repositoriesGet Scm Repository
Read one source repository, with its provider and default branch identifiers.
app_store_connect.get_scm_repositoryList Scm Repository Git References
List the branches and tags of one repository as Xcode Cloud sees them. Their identifiers are what start_ci_build_run takes as sourceBranchOrTagId.
app_store_connect.list_scm_repository_git_referencesList Scm Repository Pull Requests
List the pull requests of one repository as Xcode Cloud sees them. Their identifiers are what start_ci_build_run takes as scmPullRequestId.
app_store_connect.list_scm_repository_pull_requestsGet Scm Git Reference
Read one branch or tag of a repository as Xcode Cloud sees it.
app_store_connect.get_scm_git_referenceGet Scm Pull Request
Read one pull request of a repository as Xcode Cloud sees it.
app_store_connect.get_scm_pull_requestList Beta Feedback Screenshot Submissions
List the screenshot feedback testers sent from TestFlight for one app, with the build and tester each submission came from. Screenshot download URLs expire, so fetch them soon after listing.
app_store_connect.list_beta_feedback_screenshot_submissionsGet Beta Feedback Screenshot Submission
Read one screenshot feedback submission with its device details, attached screenshots, and the build and tester it came from.
app_store_connect.get_beta_feedback_screenshot_submissionDelete Beta Feedback Screenshot Submission
Delete a screenshot feedback submission from App Store Connect. The screenshots and comment are removed permanently.
app_store_connect.delete_beta_feedback_screenshot_submissionList Beta Feedback Crash Submissions
List the crash feedback testers sent from TestFlight for one app, with the build and tester each submission came from. Use get_beta_feedback_crash_log to read the crash log text of one submission.
app_store_connect.list_beta_feedback_crash_submissionsGet Beta Feedback Crash Submission
Read one crash feedback submission with its device details and the build and tester it came from.
app_store_connect.get_beta_feedback_crash_submissionDelete Beta Feedback Crash Submission
Delete a crash feedback submission from App Store Connect. The crash log and comment are removed permanently.
app_store_connect.delete_beta_feedback_crash_submissionGet Beta Feedback Crash Log
Read the full crash log text attached to one crash feedback submission.
app_store_connect.get_beta_feedback_crash_logGet Beta Recruitment Criterion
Read the recruitment criteria of a TestFlight group, which restrict who can join through its public link by device family and OS version. Returns null when the group has no criteria.
app_store_connect.get_beta_recruitment_criterionCreate Beta Recruitment Criterion
Set recruitment criteria on a TestFlight group so only testers on the listed device families and OS versions can join through its public link. A group can hold one set of criteria; update or delete it afterwards.
app_store_connect.create_beta_recruitment_criterionUpdate Beta Recruitment Criterion
Replace the device family and OS version filters of existing recruitment criteria. The previous filters are overwritten.
app_store_connect.update_beta_recruitment_criterionDelete Beta Recruitment Criterion
Delete the recruitment criteria of a TestFlight group, so anyone with the public link can join again.
app_store_connect.delete_beta_recruitment_criterionList Beta Recruitment Criterion Options
List the device families and OS versions App Store Connect accepts in recruitment criteria, to pick valid minimumOsInclusive and maximumOsInclusive values.
app_store_connect.list_beta_recruitment_criterion_optionsGet Beta Recruitment Criterion Compatible Build Check
Check whether a TestFlight group has a build that testers matching its recruitment criteria could install.
app_store_connect.get_beta_recruitment_criterion_compatible_build_checkList Beta App Clip Invocations
List the App Clip invocations testers can launch from TestFlight for one App Clip build bundle, with the localized titles of each. Find build bundle identifiers with list_build_bundles.
app_store_connect.list_beta_app_clip_invocationsGet Beta App Clip Invocation
Read one TestFlight App Clip invocation together with its localized titles.
app_store_connect.get_beta_app_clip_invocationCreate Beta App Clip Invocation
Add an App Clip experience that testers launch from the TestFlight app, creating its localized titles in the same request. At least one localization is required.
app_store_connect.create_beta_app_clip_invocationUpdate Beta App Clip Invocation
Change the invocation URL of a TestFlight App Clip invocation. The previous URL is overwritten.
app_store_connect.update_beta_app_clip_invocationDelete Beta App Clip Invocation
Delete a TestFlight App Clip invocation and its localized titles. Testers can no longer launch that experience from TestFlight.
app_store_connect.delete_beta_app_clip_invocationCreate Beta App Clip Invocation Localization
Add a localized title in one more locale to an existing TestFlight App Clip invocation.
app_store_connect.create_beta_app_clip_invocation_localizationUpdate Beta App Clip Invocation Localization
Change the title of one localized App Clip invocation title. The locale itself cannot be changed; the previous title is overwritten.
app_store_connect.update_beta_app_clip_invocation_localizationDelete Beta App Clip Invocation Localization
Delete one localized title of a TestFlight App Clip invocation.
app_store_connect.delete_beta_app_clip_invocation_localizationList Build Bundles
List the bundles (app, App Clip, and watch app) contained in one uploaded build, with their bundle identifiers, architectures, entitlements, and dSYM download URL. Every bundle of the build is returned in one call: App Store Connect only exposes bundles as an include of the build, capped at 50, and offers no cursor. Build bundle identifiers are needed for the App Clip and file size actions.
app_store_connect.list_build_bundlesGet Build Bundle App Clip Domain Cache Status
Read the cached validation status of the associated domains an App Clip build bundle declares, as Apple's CDN last recorded it. Returns null when App Store Connect has no status for the bundle.
app_store_connect.get_build_bundle_app_clip_domain_cache_statusGet Build Bundle App Clip Domain Debug Status
Read the debug-mode validation status of the associated domains an App Clip build bundle declares, which checks the domains directly instead of Apple's CDN cache. Returns null when App Store Connect has no status for the bundle.
app_store_connect.get_build_bundle_app_clip_domain_debug_statusList Build Bundle File Sizes
List the download and install sizes of one build bundle per device model and OS version, as App Store Connect computed them after processing.
app_store_connect.list_build_bundle_file_sizesGet App Beta Tester Usages
Read TestFlight usage metrics for one app: sessions, crashes, and feedback over the chosen period, either as one aggregate row or as one row per tester.
app_store_connect.get_app_beta_tester_usagesGet Beta Group Beta Tester Usages
Read TestFlight usage metrics for one group: sessions, crashes, and feedback over the chosen period, either as one aggregate row or as one row per tester.
app_store_connect.get_beta_group_beta_tester_usagesGet Beta Tester Usages
Read TestFlight usage metrics of one tester in one app: sessions, crashes, and feedback over the chosen period.
app_store_connect.get_beta_tester_usagesGet Build Beta Build Usages
Read TestFlight usage metrics of one build: invitations, installs, sessions, crashes, and feedback since the build became available.
app_store_connect.get_build_beta_build_usagesList Subscription Introductory Offers
List the introductory offers of one auto-renewable subscription, with the territory and price point of each offer. Filter by territory to inspect one storefront.
app_store_connect.list_subscription_introductory_offersCreate Subscription Introductory Offer
Create an introductory offer for an auto-renewable subscription. A FREE_TRIAL offer needs no price point; PAY_AS_YOU_GO and PAY_UP_FRONT offers need the subscription price point of the territory. Apple allows one active introductory offer per territory at a time. Sandbox may take up to an hour to reflect the change.
app_store_connect.create_subscription_introductory_offerUpdate Subscription Introductory Offer
Change the end date of an introductory offer, or remove the end date so the offer runs until it is deleted. Apple allows no other change; create a new offer to change the price, duration, or mode.
app_store_connect.update_subscription_introductory_offerDelete Subscription Introductory Offer
Delete an introductory offer. Customers who already redeemed it keep their discounted period.
app_store_connect.delete_subscription_introductory_offerList Subscription Promotional Offers
List the promotional offers of one auto-renewable subscription. Use list_subscription_promotional_offer_prices to read the territory prices of an offer.
app_store_connect.list_subscription_promotional_offersGet Subscription Promotional Offer
Read one promotional offer by its App Store Connect identifier.
app_store_connect.get_subscription_promotional_offerCreate Subscription Promotional Offer
Create a promotional offer for an auto-renewable subscription together with its territory prices. The offer code becomes the identifier your app passes to StoreKit and cannot be changed later.
app_store_connect.create_subscription_promotional_offerUpdate Subscription Promotional Offer
Set territory prices on an existing promotional offer. Each submitted territory replaces the price already stored for it; other attributes of the offer cannot be changed after creation.
app_store_connect.update_subscription_promotional_offerDelete Subscription Promotional Offer
Delete a promotional offer. Apps can no longer present it, and customers who already redeemed it keep their discounted period.
app_store_connect.delete_subscription_promotional_offerList Subscription Promotional Offer Prices
List the territory prices of one promotional offer, with the currency and customer price of each price point.
app_store_connect.list_subscription_promotional_offer_pricesList Subscription Offer Codes
List the offer code configurations of one auto-renewable subscription, with the code counts and active state of each configuration.
app_store_connect.list_subscription_offer_codesGet Subscription Offer Code
Read one offer code configuration by its App Store Connect identifier.
app_store_connect.get_subscription_offer_codeCreate Subscription Offer Code
Create an offer code configuration for an auto-renewable subscription together with its territory prices. Generate the redeemable codes afterwards with create_subscription_offer_code_custom_code or create_subscription_offer_code_one_time_use_code.
app_store_connect.create_subscription_offer_codeUpdate Subscription Offer Code
Activate or deactivate an offer code configuration. Deactivating it stops every custom and one-time use code of the configuration from being redeemed; Apple allows no other change after creation.
app_store_connect.update_subscription_offer_codeList Subscription Offer Code Prices
List the territory prices of one offer code configuration, with the currency and customer price of each price point.
app_store_connect.list_subscription_offer_code_pricesList Subscription Offer Code Custom Codes
List the custom codes generated for one offer code configuration.
app_store_connect.list_subscription_offer_code_custom_codesGet Subscription Offer Code Custom Code
Read one custom code batch by its App Store Connect identifier.
app_store_connect.get_subscription_offer_code_custom_codeCreate Subscription Offer Code Custom Code
Generate a custom code for an offer code configuration, which many customers can redeem up to the given number of times. The code text cannot be changed once created.
app_store_connect.create_subscription_offer_code_custom_codeUpdate Subscription Offer Code Custom Code
Activate or deactivate a custom code. A deactivated code can no longer be redeemed until it is activated again.
app_store_connect.update_subscription_offer_code_custom_codeList Subscription Offer Code One Time Use Codes
List the one-time use code batches generated for one offer code configuration. The code values themselves are only available as a CSV download in App Store Connect.
app_store_connect.list_subscription_offer_code_one_time_use_codesGet Subscription Offer Code One Time Use Code
Read one one-time use code batch by its App Store Connect identifier.
app_store_connect.get_subscription_offer_code_one_time_use_codeCreate Subscription Offer Code One Time Use Code
Generate a batch of one-time use codes for an offer code configuration. Each code can be redeemed once; download the code values from App Store Connect afterwards.
app_store_connect.create_subscription_offer_code_one_time_use_codeUpdate Subscription Offer Code One Time Use Code
Activate or deactivate a one-time use code batch. Deactivating it stops every unredeemed code in the batch from being redeemed.
app_store_connect.update_subscription_offer_code_one_time_use_codeList Win Back Offers
List the win-back offers of one auto-renewable subscription. Use list_win_back_offer_prices to read the territory prices of an offer.
app_store_connect.list_win_back_offersGet Win Back Offer
Read one win-back offer by its App Store Connect identifier.
app_store_connect.get_win_back_offerCreate Win Back Offer
Create a win-back offer for lapsed subscribers of an auto-renewable subscription together with its prices, one subscription price point per territory. The offer identifier, duration, mode, and period count cannot be changed later.
app_store_connect.create_win_back_offerUpdate Win Back Offer
Change the schedule, priority, promotion intent, or customer eligibility of a win-back offer. Only the given fields change; the identifier, duration, mode, period count, and prices cannot be changed after creation.
app_store_connect.update_win_back_offerDelete Win Back Offer
Delete a win-back offer. Apps can no longer present it, and customers who already redeemed it keep their discounted period.
app_store_connect.delete_win_back_offerList Win Back Offer Prices
List the territory prices of one win-back offer, with the currency and customer price of each price point.
app_store_connect.list_win_back_offer_pricesUpdate User
Change the roles, app visibility, or provisioning access of a team member. Roles and visible apps replace the current values rather than adding to them. Pass at least one field to change.
app_store_connect.update_userDelete User
Remove a member from the App Store Connect team. They lose access to every app and to any API keys tied to their account.
app_store_connect.delete_userList User Visible Apps
List the apps a team member can see. For a user with allAppsVisible the list reflects every app on the team.
app_store_connect.list_user_visible_appsAdd Visible Apps To User
Make additional apps visible to a team member who does not have access to all apps.
app_store_connect.add_visible_apps_to_userRemove Visible Apps From User
Hide apps from a team member so they can no longer open them in App Store Connect.
app_store_connect.remove_visible_apps_from_userReplace User Visible Apps
Replace the whole set of apps a team member can see. Apps missing from the new list are hidden from the user.
app_store_connect.replace_user_visible_appsList User Invitations
List pending invitations to join the App Store Connect team, optionally narrowed by email, role, or visible app.
app_store_connect.list_user_invitationsGet User Invitation
Read one pending team invitation by identifier.
app_store_connect.get_user_invitationInvite User
Invite someone to join the App Store Connect team with the given roles. Apple emails them an activation link that expires after three days; the invitation can be cancelled until it is accepted.
app_store_connect.invite_userCancel User Invitation
Cancel a pending team invitation. The activation link stops working; invite the person again if needed.
app_store_connect.cancel_user_invitationList User Invitation Visible Apps
List the apps a pending invitation will make visible to the invited user.
app_store_connect.list_user_invitation_visible_appsList Actors
Resolve audit-log actor identifiers, such as the submitter of a review submission, to the team member, API key, or system that performed the action. App Store Connect requires at least one identifier.
app_store_connect.list_actorsGet Actor
Read one audit-log actor by identifier.
app_store_connect.get_actorList Sandbox Testers
List the Sandbox Apple Accounts of the team used to test in-app purchases. Sandbox accounts are created and deleted in App Store Connect, not through the API.
app_store_connect.list_sandbox_testersUpdate Sandbox Tester
Change the territory, interrupted-purchase setting, or subscription renewal rate of a sandbox tester. Changes can take up to an hour to reach the sandbox environment. Pass at least one field to change.
app_store_connect.update_sandbox_testerClear Sandbox Tester Purchase History
Erase the purchase history of sandbox testers so they can test first-time purchases again. The history cannot be restored.
app_store_connect.clear_sandbox_tester_purchase_historyList Analytics Report Requests
List the analytics report requests of one app, which are the entry point to its analytics reports.
app_store_connect.list_analytics_report_requestsGet Analytics Report Request
Read one analytics report request by identifier.
app_store_connect.get_analytics_report_requestCreate Analytics Report Request
Ask App Store Connect to generate analytics reports for an app. ONGOING produces new daily, weekly, and monthly reports until the request is deleted or stops for inactivity; ONE_TIME_SNAPSHOT delivers historical data once. Reports appear asynchronously, so list them later.
app_store_connect.create_analytics_report_requestDelete Analytics Report Request
Delete an analytics report request. App Store Connect stops producing its reports and the existing report instances are no longer listed.
app_store_connect.delete_analytics_report_requestList Analytics Reports
List the report types available under one analytics report request, optionally narrowed by category or exact name.
app_store_connect.list_analytics_reportsGet Analytics Report
Read one analytics report type by identifier.
app_store_connect.get_analytics_reportList Analytics Report Instances
List the processed instances of one analytics report, each covering a daily, weekly, or monthly period.
app_store_connect.list_analytics_report_instancesGet Analytics Report Instance
Read one analytics report instance by identifier.
app_store_connect.get_analytics_report_instanceList Analytics Report Segments
List the downloadable segments of one analytics report instance. Each url points at a gzip-compressed file that the caller downloads itself; the links expire five minutes after they are issued, so call this action right before downloading.
app_store_connect.list_analytics_report_segmentsList Diagnostic Signatures
List the diagnostic signatures App Store Connect collected for one build: recurring call patterns behind disk writes, hangs, or slow launches, weighted by how critical they are.
app_store_connect.list_diagnostic_signaturesGet Diagnostic Signature Logs
Fetch the anonymized backtrace logs App Store Connect recorded for one diagnostic signature, including call stack trees and device metadata.
app_store_connect.get_diagnostic_signature_logsGet App Perf Power Metrics
Fetch the performance and power metrics of the most recent versions of an app, such as launch time, hang rate, memory, and battery use, in the xcodeMetrics document format. Use get_build_perf_power_metrics for one specific build.
app_store_connect.get_app_perf_power_metricsGet Build Perf Power Metrics
Fetch the performance and power metrics collected for one build in the xcodeMetrics document format.
app_store_connect.get_build_perf_power_metricsList Subscription Groups
List the subscription groups of one app, optionally narrowed by reference name or by the state of the subscriptions they contain.
app_store_connect.list_subscription_groupsGet Subscription Group
Read one subscription group by its App Store Connect identifier.
app_store_connect.get_subscription_groupCreate Subscription Group
Create a subscription group for an app. Subscriptions are created inside a group, and customers can switch between the subscriptions of one group.
app_store_connect.create_subscription_groupUpdate Subscription Group
Rename a subscription group. The new reference name replaces the existing one.
app_store_connect.update_subscription_groupDelete Subscription Group
Delete a subscription group. App Store Connect only deletes groups that no longer contain subscriptions that have been approved.
app_store_connect.delete_subscription_groupList Subscription Group Localizations
List the customer-facing localized names of one subscription group.
app_store_connect.list_subscription_group_localizationsGet Subscription Group Localization
Read one subscription group localization by its App Store Connect identifier.
app_store_connect.get_subscription_group_localizationCreate Subscription Group Localization
Add the customer-facing name of a subscription group in one locale. Each locale can only be added once per group.
app_store_connect.create_subscription_group_localizationUpdate Subscription Group Localization
Change the customer-facing name or custom app name of a subscription group in one locale. Pass at least one field; the locale itself cannot be changed.
app_store_connect.update_subscription_group_localizationDelete Subscription Group Localization
Delete the customer-facing name of a subscription group in one locale.
app_store_connect.delete_subscription_group_localizationList Subscriptions
List the auto-renewable subscriptions of one subscription group, optionally narrowed by name, product identifier, or state.
app_store_connect.list_subscriptionsGet Subscription
Read one auto-renewable subscription by its App Store Connect identifier.
app_store_connect.get_subscriptionCreate Subscription
Create an auto-renewable subscription inside a subscription group. The product identifier cannot be changed afterwards, and the subscription still needs localizations, a price, availability, and a review submission before it can go on sale.
app_store_connect.create_subscriptionUpdate Subscription
Change the reference name, subscription period, Family Sharing setting, review note, or group level of a subscription. Pass at least one field; each given field overwrites the existing value. Family Sharing cannot be turned off again once enabled for an approved subscription.
app_store_connect.update_subscriptionDelete Subscription
Delete an auto-renewable subscription. App Store Connect only deletes subscriptions that have never been approved; approved subscriptions can only be removed from sale.
app_store_connect.delete_subscriptionList Subscription Localizations
List the customer-facing localized names and descriptions of one subscription.
app_store_connect.list_subscription_localizationsGet Subscription Localization
Read one subscription localization by its App Store Connect identifier.
app_store_connect.get_subscription_localizationCreate Subscription Localization
Add the customer-facing name and description of a subscription in one locale. Each locale can only be added once per subscription.
app_store_connect.create_subscription_localizationUpdate Subscription Localization
Change the customer-facing name or description of a subscription in one locale. Pass at least one field; the locale itself cannot be changed.
app_store_connect.update_subscription_localizationDelete Subscription Localization
Delete the customer-facing name and description of a subscription in one locale.
app_store_connect.delete_subscription_localizationList Subscription Prices
List the current and scheduled prices of one subscription, with the territory and price point of each price. Filter by territory, payment plan, or price point.
app_store_connect.list_subscription_pricesCreate Subscription Price
Set the price of a subscription in one territory from a subscription price point, either as the initial price or as a scheduled price change. Use list_subscription_price_points to find the price point identifier. A scheduled change can be removed again with delete_subscription_price.
app_store_connect.create_subscription_priceDelete Subscription Price
Delete a scheduled price change of a subscription before it takes effect. The price that is already in effect cannot be deleted.
app_store_connect.delete_subscription_priceList Subscription Price Points
List the price points a subscription can be priced at, with the customer price and developer proceeds of each. Apple recommends filtering by territory and plans to make that filter mandatory.
app_store_connect.list_subscription_price_pointsGet Subscription Price Point
Read one subscription price point by its App Store Connect identifier.
app_store_connect.get_subscription_price_pointList Subscription Price Point Equalizations
List the price points in other territories that App Store Connect considers equivalent to one subscription price point, which is how a price set in one territory is carried over to the rest.
app_store_connect.list_subscription_price_point_equalizationsList Subscription Price Point Adjusted Equalizations
List the adjusted territory equalizations of one subscription price point, the equivalents App Store Connect proposes after its territory-specific price adjustments.
app_store_connect.list_subscription_price_point_adjusted_equalizationsGet Subscription Grace Period
Read the billing grace period settings of an app, either by app or by the grace period record identifier. Pass exactly one of appId or subscriptionGracePeriodId.
app_store_connect.get_subscription_grace_periodUpdate Subscription Grace Period
Change the billing grace period settings of an app: turn it on or off in production or the sandbox, set its length, or choose which renewals it covers. Pass at least one field; the change applies to every subscription of the app.
app_store_connect.update_subscription_grace_periodList Subscription Plan Availabilities
List the territory availability records of one subscription, one per payment plan. Use list_subscription_plan_availability_territories for the full territory list of a record.
app_store_connect.list_subscription_plan_availabilitiesGet Subscription Plan Availability
Read one subscription plan availability by its App Store Connect identifier.
app_store_connect.get_subscription_plan_availabilityCreate Subscription Plan Availability
Make one payment plan of a subscription available in a set of territories. Each plan type can only have one availability record per subscription; use update_subscription_plan_availability to change an existing one.
app_store_connect.create_subscription_plan_availabilityUpdate Subscription Plan Availability
Change the territories a subscription payment plan is sold in, or whether it opens automatically in new territories. Pass at least one field; availableTerritoryIds replaces the whole territory list, so territories left out stop selling the plan.
app_store_connect.update_subscription_plan_availabilityList Subscription Plan Availability Territories
List the territories in which one subscription plan availability sells the plan.
app_store_connect.list_subscription_plan_availability_territoriesList Subscription Versions
List the versions of one subscription, optionally narrowed by review state. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.list_subscription_versionsGet Subscription Version
Read one subscription version by its App Store Connect identifier. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.get_subscription_versionCreate Subscription Version
Create a new draft version of a subscription so its localized metadata can be edited and submitted for review while the approved version stays live. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.create_subscription_versionList Subscription Version Localizations
List the localized names and descriptions attached to one subscription version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.list_subscription_version_localizationsGet Subscription Version Localization
Read one subscription version localization by its App Store Connect identifier. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.get_subscription_version_localizationCreate Subscription Version Localization
Add the customer-facing name and description of a subscription in one locale to a subscription version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.create_subscription_version_localizationUpdate Subscription Version Localization
Change the customer-facing name or description of a subscription version localization. Pass at least one field; the locale itself cannot be changed. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.update_subscription_version_localizationDelete Subscription Version Localization
Delete one localization from a subscription version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.delete_subscription_version_localizationList Subscription Group Versions
List the versions of one subscription group, optionally narrowed by review state. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.list_subscription_group_versionsGet Subscription Group Version
Read one subscription group version by its App Store Connect identifier. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.get_subscription_group_versionCreate Subscription Group Version
Create a new draft version of a subscription group so its localized names can be edited and submitted for review while the approved version stays live. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.create_subscription_group_versionList Subscription Group Version Localizations
List the localized names attached to one subscription group version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.list_subscription_group_version_localizationsGet Subscription Group Version Localization
Read one subscription group version localization by its App Store Connect identifier. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.get_subscription_group_version_localizationCreate Subscription Group Version Localization
Add the customer-facing name of a subscription group in one locale to a subscription group version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.create_subscription_group_version_localizationUpdate Subscription Group Version Localization
Change the customer-facing name or custom app name of a subscription group version localization. Pass at least one field; the locale itself cannot be changed. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.update_subscription_group_version_localizationDelete Subscription Group Version Localization
Delete one localization from a subscription group version. Versions belong to the App Store Connect API 4.4 review flow: a version is a draft of the localized metadata that goes through App Review, and the live record is replaced once the version is approved.
app_store_connect.delete_subscription_group_version_localizationList In App Purchases
List the in-app purchases of one app (consumables, non-consumables, and non-renewing subscriptions; auto-renewable subscriptions are a separate family). Filter by type, state, name, or product identifier.
app_store_connect.list_in_app_purchasesGet In App Purchase
Read one in-app purchase by its App Store Connect identifier.
app_store_connect.get_in_app_purchaseCreate In App Purchase
Create an in-app purchase for an app. The product identifier is permanent and cannot be reused after deletion, so choose it carefully. The purchase starts in MISSING_METADATA until localizations, a price schedule, and a review screenshot are added.
app_store_connect.create_in_app_purchaseUpdate In App Purchase
Update the reference name, review note, or Family Sharing flag of an in-app purchase. Pass at least one field; each given field overwrites the current value.
app_store_connect.update_in_app_purchaseDelete In App Purchase
Delete an in-app purchase that has never been approved. Its product identifier can never be used again for this app.
app_store_connect.delete_in_app_purchaseList In App Purchase Localizations
List the localized display names and descriptions of one in-app purchase, one record per locale.
app_store_connect.list_in_app_purchase_localizationsGet In App Purchase Localization
Read one in-app purchase localization by its identifier.
app_store_connect.get_in_app_purchase_localizationCreate In App Purchase Localization
Add the display name and description of an in-app purchase for one locale. Each locale can have only one localization per purchase.
app_store_connect.create_in_app_purchase_localizationUpdate In App Purchase Localization
Overwrite the display name or description of an in-app purchase localization. Pass at least one field; the locale itself cannot be changed.
app_store_connect.update_in_app_purchase_localizationDelete In App Purchase Localization
Delete one locale of an in-app purchase's display name and description.
app_store_connect.delete_in_app_purchase_localizationList In App Purchase Price Points
List the price points available to an in-app purchase, with the customer price and proceeds per territory. Use a price point identifier from here when building a price schedule or offer code price.
app_store_connect.list_in_app_purchase_price_pointsList In App Purchase Price Point Equalizations
List the price points in other territories that Apple considers equivalent to one price point, which is how automatic prices for a base territory are derived.
app_store_connect.list_in_app_purchase_price_point_equalizationsGet In App Purchase Price Schedule
Read the price schedule of an in-app purchase together with its base territory. Returns null when the purchase has no price schedule yet.
app_store_connect.get_in_app_purchase_price_scheduleCreate In App Purchase Price Schedule
Set the price schedule of an in-app purchase: a base territory plus manual prices for specific territories. Territories without a manual price get automatic prices equalized from the base territory. Posting a schedule replaces the prices App Store Connect currently has for the purchase.
app_store_connect.create_in_app_purchase_price_scheduleList In App Purchase Price Schedule Manual Prices
List the manually set prices of an in-app purchase price schedule, with the price point, customer price, and proceeds of each.
app_store_connect.list_in_app_purchase_price_schedule_manual_pricesList In App Purchase Price Schedule Automatic Prices
List the prices App Store Connect derived automatically from the base territory of an in-app purchase price schedule.
app_store_connect.list_in_app_purchase_price_schedule_automatic_pricesGet In App Purchase Price Schedule Base Territory
Read the base territory of an in-app purchase price schedule, including its currency.
app_store_connect.get_in_app_purchase_price_schedule_base_territoryGet In App Purchase Availability
Read the availability record of an in-app purchase, which says whether it is offered in new territories automatically. Returns null when no availability has been set. Use list_in_app_purchase_available_territories for the territory list.
app_store_connect.get_in_app_purchase_availabilityCreate In App Purchase Availability
Set the territories an in-app purchase is sold in. The list replaces the current availability entirely, so territories left out are removed from sale.
app_store_connect.create_in_app_purchase_availabilityList In App Purchase Available Territories
List the territories an in-app purchase is currently sold in, using the availability record identifier from get_in_app_purchase_availability.
app_store_connect.list_in_app_purchase_available_territoriesGet In App Purchase Content
Read the metadata and temporary download URL of the hosted content package of an in-app purchase. Returns null when no content has been uploaded.
app_store_connect.get_in_app_purchase_contentList In App Purchase Versions
List the metadata versions of an in-app purchase, optionally narrowed to one review state.
app_store_connect.list_in_app_purchase_versionsGet In App Purchase Version
Read one in-app purchase version by its identifier.
app_store_connect.get_in_app_purchase_versionCreate In App Purchase Version
Create a new metadata version of an in-app purchase so its display text and images can be edited and reviewed without taking the approved version off sale.
app_store_connect.create_in_app_purchase_versionList In App Purchase Version Localizations
List the localized display names and descriptions attached to one in-app purchase version.
app_store_connect.list_in_app_purchase_version_localizationsGet In App Purchase Version Localization
Read one localization of an in-app purchase version by its identifier.
app_store_connect.get_in_app_purchase_version_localizationCreate In App Purchase Version Localization
Add the display name and description of an in-app purchase version for one locale.
app_store_connect.create_in_app_purchase_version_localizationUpdate In App Purchase Version Localization
Overwrite the display name or description of an in-app purchase version localization. Pass at least one field.
app_store_connect.update_in_app_purchase_version_localizationDelete In App Purchase Version Localization
Delete one locale from an in-app purchase version.
app_store_connect.delete_in_app_purchase_version_localizationSubmit In App Purchase For Review
Submit an in-app purchase to App Review. The purchase must be in READY_TO_SUBMIT; once submitted it cannot be edited until review finishes.
app_store_connect.submit_in_app_purchase_for_reviewList In App Purchase Offer Codes
List the offer code configurations of an in-app purchase, optionally narrowed to offers priced in one territory.
app_store_connect.list_in_app_purchase_offer_codesGet In App Purchase Offer Code
Read one in-app purchase offer code configuration by its identifier.
app_store_connect.get_in_app_purchase_offer_codeCreate In App Purchase Offer Code
Create an offer code configuration for an in-app purchase: who may redeem it and the discounted price per territory. Generate redeemable codes afterwards with the custom code or one-time-use code actions.
app_store_connect.create_in_app_purchase_offer_codeUpdate In App Purchase Offer Code
Activate or deactivate an in-app purchase offer code. Deactivating stops every custom and one-time-use code of the offer from being redeemed.
app_store_connect.update_in_app_purchase_offer_codeList In App Purchase Offer Code Prices
List the discounted prices of an in-app purchase offer code per territory, with the price point, customer price, and proceeds of each.
app_store_connect.list_in_app_purchase_offer_code_pricesList In App Purchase Offer Code Custom Codes
List the custom codes generated for an in-app purchase offer code.
app_store_connect.list_in_app_purchase_offer_code_custom_codesCreate In App Purchase Offer Code Custom Code
Create a custom code for an in-app purchase offer that customers redeem by typing it, with a redemption limit and optional expiration date.
app_store_connect.create_in_app_purchase_offer_code_custom_codeUpdate In App Purchase Offer Code Custom Code
Activate or deactivate one custom code of an in-app purchase offer without touching the other codes of the offer.
app_store_connect.update_in_app_purchase_offer_code_custom_codeList In App Purchase Offer Code One Time Use Codes
List the one-time-use code batches generated for an in-app purchase offer code. The code values are only available as a CSV download in App Store Connect.
app_store_connect.list_in_app_purchase_offer_code_one_time_use_codesCreate In App Purchase Offer Code One Time Use Code
Generate a batch of one-time-use codes for an in-app purchase offer. Download the generated code values from App Store Connect afterwards; they are not returned here.
app_store_connect.create_in_app_purchase_offer_code_one_time_use_codeUpdate In App Purchase Offer Code One Time Use Code
Activate or deactivate one batch of one-time-use codes of an in-app purchase offer.
app_store_connect.update_in_app_purchase_offer_code_one_time_use_codeList Promoted Purchases
List the in-app purchases and subscriptions promoted on the App Store product page of one app, in display order.
app_store_connect.list_promoted_purchasesGet Promoted Purchase
Read one promoted purchase by its identifier.
app_store_connect.get_promoted_purchaseCreate Promoted Purchase
Promote an in-app purchase or a subscription on the App Store product page of an app. Pass exactly one of inAppPurchaseId or subscriptionId. A promotional image must still be uploaded in App Store Connect before the promotion can be submitted.
app_store_connect.create_promoted_purchaseUpdate Promoted Purchase
Change whether a promoted purchase is enabled or visible to all customers. Pass at least one field.
app_store_connect.update_promoted_purchaseDelete Promoted Purchase
Remove a promotion from the App Store product page of an app.
app_store_connect.delete_promoted_purchaseReorder Promoted Purchases
Set the display order of the promoted purchases of an app. The list replaces the current order, so include every promoted purchase that should stay listed.
app_store_connect.reorder_promoted_purchasesList App Custom Product Pages
List the custom product pages of one app, optionally only the visible or only the hidden ones.
app_store_connect.list_app_custom_product_pagesGet App Custom Product Page
Read one custom product page by its App Store Connect identifier.
app_store_connect.get_app_custom_product_pageCreate App Custom Product Page
Create a custom product page for an app. Copy the metadata of an App Store version (appStoreVersionTemplateId) or of another custom product page (customProductPageTemplateId), or create the first page version inline with a deep link and localized promotional text. The page starts hidden until its first version passes App Review; use list_app_custom_product_page_versions to find the version to work on.
app_store_connect.create_app_custom_product_pageUpdate App Custom Product Page
Rename a custom product page or toggle its visibility on the App Store. Overwrites the given fields; pass at least one.
app_store_connect.update_app_custom_product_pageDelete App Custom Product Page
Delete a custom product page together with all of its versions and localizations. Its App Store URL stops working.
app_store_connect.delete_app_custom_product_pageList App Custom Product Page Versions
List the versions of one custom product page, optionally narrowed to some review states.
app_store_connect.list_app_custom_product_page_versionsGet App Custom Product Page Version
Read one custom product page version by its App Store Connect identifier.
app_store_connect.get_app_custom_product_page_versionCreate App Custom Product Page Version
Create a new editable version of a custom product page, for example to change it after the current version was approved. App Store Connect rejects a new version while the page already has one that is still being prepared or reviewed.
app_store_connect.create_app_custom_product_page_versionUpdate App Custom Product Page Version
Set or clear the deep link of a custom product page version. Overwrites the existing deep link; pass null to remove it.
app_store_connect.update_app_custom_product_page_versionList App Custom Product Page Localizations
List the localizations of one custom product page version, optionally narrowed to some locales.
app_store_connect.list_app_custom_product_page_localizationsGet App Custom Product Page Localization
Read one custom product page localization by its App Store Connect identifier.
app_store_connect.get_app_custom_product_page_localizationCreate App Custom Product Page Localization
Add a locale to a custom product page version with optional promotional text. Screenshots and app previews for the locale are uploaded separately. App Store Connect rejects a locale the version already has.
app_store_connect.create_app_custom_product_page_localizationUpdate App Custom Product Page Localization
Replace the promotional text of a custom product page localization, or clear it with null.
app_store_connect.update_app_custom_product_page_localizationDelete App Custom Product Page Localization
Remove a locale from a custom product page version, including the screenshots and previews attached to it.
app_store_connect.delete_app_custom_product_page_localizationList App Store Version Experiments
List the product page optimization tests of one app, optionally narrowed to some states, with the App Store version each test uses as its control.
app_store_connect.list_app_store_version_experimentsGet App Store Version Experiment
Read one product page optimization test, including the App Store version that serves as its control.
app_store_connect.get_app_store_version_experimentCreate App Store Version Experiment
Create a product page optimization test for an app on one platform. The test starts in PREPARE_FOR_SUBMISSION; add treatments with create_app_store_version_experiment_treatment, then start it with update_app_store_version_experiment once its treatments are approved.
app_store_connect.create_app_store_version_experimentUpdate App Store Version Experiment
Rename a product page optimization test, change its traffic proportion, or start it by passing started true. Starting a test is not reversible: it begins serving treatments to App Store traffic and can only be stopped, not returned to draft. Pass at least one field.
app_store_connect.update_app_store_version_experimentDelete App Store Version Experiment
Delete a product page optimization test together with its treatments. A running test is stopped; results already collected are lost.
app_store_connect.delete_app_store_version_experimentList App Store Version Experiment Treatments
List the treatments of one product page optimization test.
app_store_connect.list_app_store_version_experiment_treatmentsGet App Store Version Experiment Treatment
Read one treatment of a product page optimization test.
app_store_connect.get_app_store_version_experiment_treatmentCreate App Store Version Experiment Treatment
Add a treatment to a product page optimization test, optionally using an alternate app icon bundled with the app. Add locales to the treatment with create_app_store_version_experiment_treatment_localization before uploading its screenshots.
app_store_connect.create_app_store_version_experiment_treatmentUpdate App Store Version Experiment Treatment
Rename a treatment or change its alternate app icon. Overwrites the given fields; pass null as appIconName to return to the default icon. Pass at least one field.
app_store_connect.update_app_store_version_experiment_treatmentDelete App Store Version Experiment Treatment
Delete a treatment from a product page optimization test, including its localizations and screenshots.
app_store_connect.delete_app_store_version_experiment_treatmentList App Store Version Experiment Treatment Localizations
List the locales of one treatment, optionally narrowed to some locales. Screenshots and previews of a treatment are attached to these localizations.
app_store_connect.list_app_store_version_experiment_treatment_localizationsGet App Store Version Experiment Treatment Localization
Read one treatment localization by its App Store Connect identifier.
app_store_connect.get_app_store_version_experiment_treatment_localizationCreate App Store Version Experiment Treatment Localization
Add a locale to a treatment so screenshots and app previews can be uploaded for it. App Store Connect rejects a locale the treatment already has.
app_store_connect.create_app_store_version_experiment_treatment_localizationDelete App Store Version Experiment Treatment Localization
Remove a locale from a treatment, including the screenshots and previews attached to it.
app_store_connect.delete_app_store_version_experiment_treatment_localizationCreate App Store Version Promotion
Promote the winning treatment of a product page optimization test to the default product page: its screenshots, previews, and app icon are applied to the given App Store version, replacing that version's current product page assets. Use list_app_store_version_experiments to find the control version (latestControlVersionId) the test ran against.
app_store_connect.create_app_store_version_promotionList Background Assets
List the Apple-hosted background asset packs of one app, with the version currently in each of the App Store, internal TestFlight, and external TestFlight slots.
app_store_connect.list_background_assetsGet Background Asset
Read one background asset pack, with the version currently in each of the App Store, internal TestFlight, and external TestFlight slots.
app_store_connect.get_background_assetCreate Background Asset
Create an Apple-hosted background asset pack record for an app. The record starts without versions; create a version next, then upload and commit the asset pack archive through the generic proxy or Xcode.
app_store_connect.create_background_assetUpdate Background Asset
Archive or unarchive a background asset pack. Archiving is the only change App Store Connect accepts on an asset pack; the identifier and versions stay as they are.
app_store_connect.update_background_assetList Background Asset Versions
List the versions of one background asset pack with their processing state and their internal TestFlight, external TestFlight, and App Store release records.
app_store_connect.list_background_asset_versionsGet Background Asset Version
Read one background asset version with its processing state, validation messages, parent asset pack, and release records.
app_store_connect.get_background_asset_versionCreate Background Asset Version
Create a new version record for a background asset pack. App Store Connect assigns the next version number automatically; the version stays in AWAITING_UPLOAD until the asset pack archive is uploaded and committed, which needs the binary upload endpoints outside these actions.
app_store_connect.create_background_asset_versionGet Background Asset Version App Store Release
Read the App Store release record of a background asset version, which tracks its App Review and distribution state.
app_store_connect.get_background_asset_version_app_store_releaseGet Background Asset Version Internal Beta Release
Read the internal TestFlight release record of a background asset version. App Store Connect creates it once the version finishes processing.
app_store_connect.get_background_asset_version_internal_beta_releaseGet Background Asset Version External Beta Release
Read the external TestFlight release record of a background asset version, which tracks its beta review state.
app_store_connect.get_background_asset_version_external_beta_releaseList Alternative Distribution Keys
List the alternative distribution public keys of the team. A key without an app applies to every alternative distribution app on the account.
app_store_connect.list_alternative_distribution_keysGet Alternative Distribution Key
Read one alternative distribution key and its public key.
app_store_connect.get_alternative_distribution_keyGet App Alternative Distribution Key
Read the alternative distribution key tied to one app, or null when the app has no key of its own.
app_store_connect.get_app_alternative_distribution_keyCreate Alternative Distribution Key
Upload the public half of an alternative distribution key pair. Without appId the key applies to every alternative distribution app on the account; with appId it is tied to that marketplace or web distribution app. The private half never goes to Apple and signs the marketplace JWTs or install verification.
app_store_connect.create_alternative_distribution_keyDelete Alternative Distribution Key
Remove an alternative distribution key from the account. Tokens signed with the matching private key stop being accepted.
app_store_connect.delete_alternative_distribution_keyList Alternative Distribution Domains
List the base web domains registered for alternative distribution on the account.
app_store_connect.list_alternative_distribution_domainsGet Alternative Distribution Domain
Read one alternative distribution domain.
app_store_connect.get_alternative_distribution_domainCreate Alternative Distribution Domain
Register the base web domain that serves a marketplace app or web distribution app. All app pages and the marketplace sitemap must live on this domain, and it is enabled for every alternative distribution app on the account.
app_store_connect.create_alternative_distribution_domainDelete Alternative Distribution Domain
Delete an alternative distribution domain. Apps served from that domain can no longer be installed through it.
app_store_connect.delete_alternative_distribution_domainGet Alternative Distribution Package
Read one alternative distribution package and the checksums of the source build it was generated from. Use list_alternative_distribution_package_versions for its downloadable versions.
app_store_connect.get_alternative_distribution_packageGet App Store Version Alternative Distribution Package
Read the alternative distribution package generated for one App Store version, or null when none exists yet.
app_store_connect.get_app_store_version_alternative_distribution_packageCreate Alternative Distribution Package
Generate the alternative distribution package for an already approved App Store version. Versions approved after alternative distribution was enabled get their package automatically; use this for versions that were approved before.
app_store_connect.create_alternative_distribution_packageList Alternative Distribution Package Versions
List the versions of an alternative distribution package with their time-limited download URLs.
app_store_connect.list_alternative_distribution_package_versionsGet Alternative Distribution Package Version
Read one alternative distribution package version and its time-limited download URL.
app_store_connect.get_alternative_distribution_package_versionList Alternative Distribution Package Version Variants
List the device-specific variants of an alternative distribution package version, each with its download URL and encrypted key blob.
app_store_connect.list_alternative_distribution_package_version_variantsGet Alternative Distribution Package Variant
Read one variant of an alternative distribution package version, with its download URL and encrypted key blob.
app_store_connect.get_alternative_distribution_package_variantList Alternative Distribution Package Version Deltas
List the delta updates of an alternative distribution package version, each with its download URL and encrypted key blob.
app_store_connect.list_alternative_distribution_package_version_deltasGet Alternative Distribution Package Delta
Read one delta update of an alternative distribution package version, with its download URL and encrypted key blob.
app_store_connect.get_alternative_distribution_package_deltaGet Marketplace Search Detail
Read the marketplace search detail of an alternative marketplace app, or null when no catalog URL has been configured.
app_store_connect.get_marketplace_search_detailCreate Marketplace Search Detail
Set the sitemap catalog URL of an alternative marketplace app so Apple can crawl it and include the marketplace apps in Spotlight search. Each marketplace app holds one search detail.
app_store_connect.create_marketplace_search_detailUpdate Marketplace Search Detail
Replace the sitemap catalog URL of an existing marketplace search detail.
app_store_connect.update_marketplace_search_detailDelete Marketplace Search Detail
Delete the marketplace search detail of an alternative marketplace app. Apple stops crawling the catalog URL.
app_store_connect.delete_marketplace_search_detailList App Events
List the in-app events of an app, optionally narrowed to some review states or identifiers.
app_store_connect.list_app_eventsGet App Event
Read one in-app event with its state, badge, purpose, and territory schedules.
app_store_connect.get_app_eventCreate App Event
Create a draft in-app event for an app. Add localizations with create_app_event_localization before submitting the event for review in App Store Connect.
app_store_connect.create_app_eventUpdate App Event
Change the reference name, badge, deep link, purchase requirement, locale, priority, purpose, or territory schedules of an in-app event. Overwrites the given fields; pass null for deepLink or purchaseRequirement to clear it. Pass at least one field.
app_store_connect.update_app_eventDelete App Event
Delete an in-app event together with its localizations. A published event is removed from the App Store.
app_store_connect.delete_app_eventList App Event Localizations
List the localized name and descriptions of an in-app event for every locale.
app_store_connect.list_app_event_localizationsGet App Event Localization
Read one in-app event localization by its identifier.
app_store_connect.get_app_event_localizationCreate App Event Localization
Add a locale to an in-app event with the name and descriptions shown in that locale. App Store Connect rejects a locale the event already has.
app_store_connect.create_app_event_localizationUpdate App Event Localization
Change the name or descriptions of an in-app event localization. Overwrites the given fields; pass null to clear a field. Pass at least one field.
app_store_connect.update_app_event_localizationDelete App Event Localization
Remove a locale from an in-app event together with the screenshots and video clips uploaded for it.
app_store_connect.delete_app_event_localizationList App Clips
List the App Clips of an app, optionally filtered by bundle identifier.
app_store_connect.list_app_clipsGet App Clip
Read one App Clip by its identifier.
app_store_connect.get_app_clipList App Clip Default Experiences
List the default experiences of an App Clip with the App Store version each one is released with. Optionally keep only experiences that are, or are not, attached to a version.
app_store_connect.list_app_clip_default_experiencesGet App Clip Default Experience
Read one default App Clip experience with its action and the App Store version it is released with.
app_store_connect.get_app_clip_default_experienceCreate App Clip Default Experience
Create a default experience for an App Clip, optionally attached to the App Store version it ships with or copied from an existing experience.
app_store_connect.create_app_clip_default_experienceUpdate App Clip Default Experience
Change the action of a default App Clip experience or the App Store version it is released with. Pass at least one field.
app_store_connect.update_app_clip_default_experienceDelete App Clip Default Experience
Delete a default App Clip experience together with its localizations and review detail.
app_store_connect.delete_app_clip_default_experienceSet App Clip Default Experience Release Version
Attach a default App Clip experience to the App Store version it is released with, replacing any version attached before.
app_store_connect.set_app_clip_default_experience_release_versionList App Clip Default Experience Localizations
List the localized subtitles of a default App Clip experience, optionally narrowed to some locales.
app_store_connect.list_app_clip_default_experience_localizationsGet App Clip Default Experience Localization
Read one default App Clip experience localization by its identifier.
app_store_connect.get_app_clip_default_experience_localizationCreate App Clip Default Experience Localization
Add a locale to a default App Clip experience with the subtitle shown on the App Clip card in that locale. The header image is uploaded separately in App Store Connect.
app_store_connect.create_app_clip_default_experience_localizationUpdate App Clip Default Experience Localization
Change the subtitle of a default App Clip experience localization, or pass null to remove it.
app_store_connect.update_app_clip_default_experience_localizationDelete App Clip Default Experience Localization
Remove a locale from a default App Clip experience together with its header image.
app_store_connect.delete_app_clip_default_experience_localizationGet App Clip Default Experience Review Detail
Read the invocation URLs App Review uses to test a default App Clip experience, or null when none were provided yet.
app_store_connect.get_app_clip_default_experience_review_detailCreate App Clip App Store Review Detail
Provide the invocation URLs App Review uses to test a default App Clip experience. Each experience has at most one review detail; use update_app_clip_app_store_review_detail to change it.
app_store_connect.create_app_clip_app_store_review_detailUpdate App Clip App Store Review Detail
Replace the invocation URLs App Review uses to test a default App Clip experience. Pass an empty list to remove them all.
app_store_connect.update_app_clip_app_store_review_detailList App Clip Advanced Experiences
List the advanced experiences of an App Clip with their localized card text. Filter by status, place match status, or action.
app_store_connect.list_app_clip_advanced_experiencesGet App Clip Advanced Experience
Read one advanced App Clip experience with its invocation URL, place, status, and localized card text.
app_store_connect.get_app_clip_advanced_experienceCreate App Clip Advanced Experience
Create an advanced App Clip experience for an invocation URL with its localized card text and optional place. App Store Connect requires a header image reserved beforehand through the appClipAdvancedExperienceImages endpoint (a binary upload, available through the proxy); pass its identifier as headerImageId.
app_store_connect.create_app_clip_advanced_experienceUpdate App Clip Advanced Experience
Change the action, business category, default language, place, header image, or localized card text of an advanced App Clip experience. Overwrites the given fields; a given localizations list is written inline and replaces the relationship. Pass at least one field.
app_store_connect.update_app_clip_advanced_experienceDelete App Clip Advanced Experience
Delete an advanced App Clip experience. App Store Connect has no DELETE endpoint for it; the experience is removed by setting its documented removed flag, after which users can no longer invoke it.
app_store_connect.delete_app_clip_advanced_experienceList Nominations
List the featuring nominations of the team in the given states, optionally narrowed by type, related app, or whether they include in-app events.
app_store_connect.list_nominationsGet Nomination
Read one featuring nomination by its identifier.
app_store_connect.get_nominationCreate Nomination
Create a featuring nomination for one or more apps. With submitted false it stays a draft you can edit; with submitted true it is sent to Apple's editorial team right away.
app_store_connect.create_nominationUpdate Nomination
Change a featuring nomination, submit a draft with submitted true, or archive it with archived true. Overwrites the given fields; a given list of apps, events, or territories replaces the current one. Pass null for publishEndDate or notes to clear it. Pass at least one field.
app_store_connect.update_nominationDelete Nomination
Delete a featuring nomination.
app_store_connect.delete_nominationGet App Game Center Detail
Read the Game Center configuration of one app, including the group it belongs to and the leaderboards shown by default. Returns null when the app has never been enabled for Game Center.
app_store_connect.get_app_game_center_detailCreate Game Center Detail
Enable Game Center for an app by creating its Game Center detail. The detail owns the achievements, leaderboards and leaderboard sets of the app, and an app has at most one of them.
app_store_connect.create_game_center_detailGet Game Center Detail
Read one Game Center detail by its App Store Connect identifier, together with the group and the default leaderboards it links to.
app_store_connect.get_game_center_detailUpdate Game Center Detail
Move a Game Center detail into a group, or change the leaderboards shown by default in the Game Center dashboard. Overwrites the relationships you pass; pass at least one. App Store Connect does not echo the linked identifiers on this call, so read them back with get_game_center_detail.
app_store_connect.update_game_center_detailGet Game Center Detail Group
Read the Game Center group a Game Center detail belongs to. Returns null when the app does not share its achievements and leaderboards with other apps.
app_store_connect.get_game_center_detail_groupList Game Center Detail Achievements
List the achievements of one Game Center detail, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_detail_achievementsList Game Center Detail Leaderboards
List the leaderboards of one Game Center detail, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_detail_leaderboardsList Game Center Detail Leaderboard Sets
List the leaderboard sets of one Game Center detail, optionally narrowed by reference name or identifier.
app_store_connect.list_game_center_detail_leaderboard_setsList Game Center Detail App Versions
List the App Store versions of the app together with their Game Center enablement, optionally narrowed to the enabled or the disabled ones.
app_store_connect.list_game_center_detail_app_versionsReplace Game Center Detail Achievements
Replace the achievements attached to a Game Center detail. The identifiers you pass become the complete set, so an achievement left out is detached from the app.
app_store_connect.replace_game_center_detail_achievementsReplace Game Center Detail Leaderboards
Replace the leaderboards attached to a Game Center detail. The identifiers you pass become the complete set, so a leaderboard left out is detached from the app.
app_store_connect.replace_game_center_detail_leaderboardsReplace Game Center Detail Leaderboard Sets
Replace the leaderboard sets attached to a Game Center detail. The identifiers you pass become the complete set, so a leaderboard set left out is detached from the app.
app_store_connect.replace_game_center_detail_leaderboard_setsReplace Game Center Detail Challenges Minimum Platform Versions
Replace the earliest App Store versions, one per platform, that may take part in Game Center challenges. The identifiers you pass become the complete set, so a platform left out no longer has a minimum version.
app_store_connect.replace_game_center_detail_challenges_minimum_platform_versionsList Game Center Groups
List the Game Center groups of the team. Apps in a group share their achievements, leaderboards and leaderboard sets, so players keep one progress across the apps.
app_store_connect.list_game_center_groupsCreate Game Center Group
Create a Game Center group. The group starts empty: an app joins it through its Game Center detail, and the achievements, leaderboards and leaderboard sets it shares are set with the replace actions.
app_store_connect.create_game_center_groupGet Game Center Group
Read one Game Center group by its App Store Connect identifier.
app_store_connect.get_game_center_groupUpdate Game Center Group
Rename a Game Center group. Overwrites the reference name; pass null to clear it. The apps and the shared records of the group are not touched.
app_store_connect.update_game_center_groupDelete Game Center Group
Delete a Game Center group. The apps that were in the group keep their own Game Center records and stop sharing progress with each other.
app_store_connect.delete_game_center_groupList Game Center Group Details
List the Game Center details of the apps that belong to one group, that is the apps sharing the achievements, leaderboards and leaderboard sets of the group.
app_store_connect.list_game_center_group_detailsList Game Center Group Achievements
List the achievements shared by one Game Center group, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_group_achievementsList Game Center Group Leaderboards
List the leaderboards shared by one Game Center group, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_group_leaderboardsList Game Center Group Leaderboard Sets
List the leaderboard sets shared by one Game Center group, optionally narrowed by reference name or identifier.
app_store_connect.list_game_center_group_leaderboard_setsReplace Game Center Group Achievements
Set which achievements one Game Center group shares. Pass the complete list: an achievement left out is no longer shared through the group.
app_store_connect.replace_game_center_group_achievementsReplace Game Center Group Leaderboards
Set which leaderboards one Game Center group shares. Pass the complete list: a leaderboard left out is no longer shared through the group.
app_store_connect.replace_game_center_group_leaderboardsReplace Game Center Group Leaderboard Sets
Set which leaderboard sets one Game Center group shares. Pass the complete list: a leaderboard set left out is no longer shared through the group.
app_store_connect.replace_game_center_group_leaderboard_setsCreate Game Center App Version
Turn Game Center on for one App Store version by creating its Game Center app version record. Everything Game Center knows about that release hangs off this record: use update_game_center_app_version to toggle it again, and add_compatibility_versions_to_game_center_app_version to keep earlier releases multiplayer compatible with it.
app_store_connect.create_game_center_app_versionGet Game Center App Version
Read one Game Center app version by its App Store Connect identifier.
app_store_connect.get_game_center_app_versionUpdate Game Center App Version
Enable or disable Game Center for the App Store version this record belongs to. Disabling it hides Game Center from players on that release without deleting its achievements or leaderboards.
app_store_connect.update_game_center_app_versionGet Game Center App Version App Store Version
Read the App Store version a Game Center app version belongs to, for example to learn its version string and review state.
app_store_connect.get_game_center_app_version_app_store_versionList Game Center App Version Compatibility Versions
List the earlier app versions that stay multiplayer compatible with this one, so players who have not updated yet can still be matched with players who have. Optionally narrowed to the compatible versions that have Game Center enabled.
app_store_connect.list_game_center_app_version_compatibility_versionsAdd Compatibility Versions To Game Center App Version
Mark earlier Game Center app versions as multiplayer compatible with this one. Adds to the versions already listed instead of replacing them.
app_store_connect.add_compatibility_versions_to_game_center_app_versionRemove Compatibility Versions From Game Center App Version
Stop treating earlier Game Center app versions as multiplayer compatible with this one. Players still on a removed version can no longer be matched with players on this one.
app_store_connect.remove_compatibility_versions_from_game_center_app_versionGet App Store Version Game Center App Version
Read the Game Center app version of one App Store version. Returns null when Game Center was never enabled for that version.
app_store_connect.get_app_store_version_game_center_app_versionSubmit Game Center Leaderboard Entry
Post a score to a Game Center leaderboard on behalf of a player. This is how a server-authoritative game reports scores its own backend computed instead of letting the game client submit them.
app_store_connect.submit_game_center_leaderboard_entrySubmit Game Center Player Achievement
Report a player's progress towards a Game Center achievement from a server instead of from the game client. Submitting 100 marks the achievement earned.
app_store_connect.submit_game_center_player_achievementCreate Game Center Achievement
Create a Game Center achievement together with its first version. Pass gameCenterDetailId when the achievement belongs to a single app, or gameCenterGroupId when it is shared by every app of a Game Center group. The achievement has no player-facing text yet; read the first version with list_game_center_achievement_versions and add locales with create_game_center_achievement_localization.
app_store_connect.create_game_center_achievementGet Game Center Achievement
Read one Game Center achievement by its App Store Connect identifier.
app_store_connect.get_game_center_achievementUpdate Game Center Achievement
Change the configuration of a Game Center achievement, or archive it so it is no longer offered to players. Overwrites the given fields; pass at least one. The vendor identifier cannot be changed after the achievement was created.
app_store_connect.update_game_center_achievementDelete Game Center Achievement
Delete a Game Center achievement together with all of its versions and localizations. Players lose the achievement and the progress recorded for it.
app_store_connect.delete_game_center_achievementList Game Center Achievement Versions
List the versions of one Game Center achievement, each with the review and release state of the localizations it carries.
app_store_connect.list_game_center_achievement_versionsSet Game Center Achievement Activity
Attach a Game Center achievement to a game activity, replacing the activity it was attached to before.
app_store_connect.set_game_center_achievement_activityCreate Game Center Achievement Version
Create a new version of a Game Center achievement. Editing the player-facing text of an achievement that is already live goes through a new version: add or change its localizations, and the version carries them through App Review.
app_store_connect.create_game_center_achievement_versionGet Game Center Achievement Version
Read one Game Center achievement version by its App Store Connect identifier.
app_store_connect.get_game_center_achievement_versionList Game Center Achievement Version Localizations
List the localizations of one Game Center achievement version, one per locale the achievement is shown in.
app_store_connect.list_game_center_achievement_version_localizationsCreate Game Center Achievement Localization
Add a locale to a Game Center achievement version with the name and the two descriptions players see before and after they earn the achievement. The achievement image for the locale is uploaded separately. App Store Connect rejects a locale the version already has.
app_store_connect.create_game_center_achievement_localizationGet Game Center Achievement Localization
Read one Game Center achievement localization by its App Store Connect identifier.
app_store_connect.get_game_center_achievement_localizationUpdate Game Center Achievement Localization
Change the name or the descriptions of a Game Center achievement localization, or clear one of them with null. Overwrites the given fields; pass at least one. The locale cannot be changed; delete the localization and create it again instead.
app_store_connect.update_game_center_achievement_localizationDelete Game Center Achievement Localization
Remove a locale from a Game Center achievement version, including the achievement image uploaded for it.
app_store_connect.delete_game_center_achievement_localizationGet Game Center Achievement Localization Image
Read the achievement image uploaded for one Game Center achievement localization, including its delivery state, or null when no image has been uploaded. Uploading an image is not covered by this connector; only the already uploaded image can be read.
app_store_connect.get_game_center_achievement_localization_imageCreate Game Center Leaderboard
Create a Game Center leaderboard owned by one app or shared by a group. App Store Connect always creates the first leaderboard version alongside it, so the player-facing text is added with create_game_center_leaderboard_localization against that version. Give recurrenceStartDate, recurrenceDuration and recurrenceRule together to make the leaderboard recurring.
app_store_connect.create_game_center_leaderboardGet Game Center Leaderboard
Read one Game Center leaderboard by its App Store Connect identifier.
app_store_connect.get_game_center_leaderboardUpdate Game Center Leaderboard
Change the configuration of a Game Center leaderboard or archive it. Overwrites the given fields and clears the ones passed as null; pass at least one. The vendorIdentifier cannot be changed. Archiving retires the leaderboard so it stops accepting scores.
app_store_connect.update_game_center_leaderboardDelete Game Center Leaderboard
Delete a Game Center leaderboard together with its versions, localizations and the scores players submitted to it.
app_store_connect.delete_game_center_leaderboardList Game Center Leaderboard Versions
List the versions of one Game Center leaderboard. Each version carries its own localizations through App Review.
app_store_connect.list_game_center_leaderboard_versionsSet Game Center Leaderboard Activity
Link a Game Center leaderboard to the game activity it belongs to, replacing any activity linked before. App Store Connect confirms the change without returning the leaderboard.
app_store_connect.set_game_center_leaderboard_activitySet Game Center Leaderboard Challenge
Link a Game Center leaderboard to the challenge that ranks players against it, replacing any challenge linked before. App Store Connect confirms the change without returning the leaderboard.
app_store_connect.set_game_center_leaderboard_challengeCreate Game Center Leaderboard Version
Create a new version of a Game Center leaderboard so its localized text can be edited and taken through App Review again. Add the text with create_game_center_leaderboard_localization against the new version.
app_store_connect.create_game_center_leaderboard_versionGet Game Center Leaderboard Version
Read one Game Center leaderboard version by its App Store Connect identifier.
app_store_connect.get_game_center_leaderboard_versionList Game Center Leaderboard Version Localizations
List the locales of one Game Center leaderboard version, each with the name, score description and score formatting shown to players.
app_store_connect.list_game_center_leaderboard_version_localizationsCreate Game Center Leaderboard Localization
Add a locale to a Game Center leaderboard version with the name and score text players see there. The image shown next to the leaderboard is uploaded separately and is not covered by this connector.
app_store_connect.create_game_center_leaderboard_localizationGet Game Center Leaderboard Localization
Read one Game Center leaderboard localization by its App Store Connect identifier.
app_store_connect.get_game_center_leaderboard_localizationUpdate Game Center Leaderboard Localization
Change the text or score formatting of a Game Center leaderboard localization. Overwrites the given fields and clears the ones passed as null; pass at least one. The locale cannot be changed.
app_store_connect.update_game_center_leaderboard_localizationDelete Game Center Leaderboard Localization
Remove a locale from a Game Center leaderboard version, including the image uploaded for it.
app_store_connect.delete_game_center_leaderboard_localizationGet Game Center Leaderboard Localization Image
Read the image shown with a Game Center leaderboard localization, including its delivery state. Returns null when no image has been uploaded for the locale. Uploading an image is not covered by this connector, only reading the one already uploaded.
app_store_connect.get_game_center_leaderboard_localization_imageCreate Game Center Leaderboard Set
Create a Game Center leaderboard set that groups related leaderboards under one entry in the Game Center dashboard, and optionally put existing leaderboards into it. App Store Connect always creates the first set version together with the set; add the localized set names with create_game_center_leaderboard_set_localization.
app_store_connect.create_game_center_leaderboard_setGet Game Center Leaderboard Set
Read one Game Center leaderboard set by its App Store Connect identifier.
app_store_connect.get_game_center_leaderboard_setUpdate Game Center Leaderboard Set
Rename a Game Center leaderboard set, or clear its reference name with null. The vendor identifier is fixed once the set exists and cannot be changed.
app_store_connect.update_game_center_leaderboard_setDelete Game Center Leaderboard Set
Delete a Game Center leaderboard set together with its versions and localizations. The leaderboards that were in the set are kept and stay available on their own.
app_store_connect.delete_game_center_leaderboard_setList Game Center Leaderboard Set Leaderboards
List the leaderboards that belong to one Game Center leaderboard set, optionally narrowed by reference name, by archived state, or to specific leaderboards.
app_store_connect.list_game_center_leaderboard_set_leaderboardsAdd Leaderboards To Game Center Leaderboard Set
Put more existing leaderboards into a Game Center leaderboard set. The leaderboards already in the set are kept.
app_store_connect.add_leaderboards_to_game_center_leaderboard_setReplace Game Center Leaderboard Set Leaderboards
Replace the whole list of leaderboards in a Game Center leaderboard set. Leaderboards missing from the new list leave the set but are not deleted.
app_store_connect.replace_game_center_leaderboard_set_leaderboardsRemove Leaderboards From Game Center Leaderboard Set
Take leaderboards out of a Game Center leaderboard set. The leaderboards themselves are kept and stay available on their own.
app_store_connect.remove_leaderboards_from_game_center_leaderboard_setList Game Center Leaderboard Set Versions
List the versions of one Game Center leaderboard set. Each version carries its own localized names through App Review.
app_store_connect.list_game_center_leaderboard_set_versionsCreate Game Center Leaderboard Set Version
Create a new editable version of a Game Center leaderboard set, for example to change its localized names after the current version went live.
app_store_connect.create_game_center_leaderboard_set_versionGet Game Center Leaderboard Set Version
Read one Game Center leaderboard set version by its App Store Connect identifier, including its review state.
app_store_connect.get_game_center_leaderboard_set_versionList Game Center Leaderboard Set Version Localizations
List the locales one Game Center leaderboard set version is translated into.
app_store_connect.list_game_center_leaderboard_set_version_localizationsCreate Game Center Leaderboard Set Localization
Add a locale to a Game Center leaderboard set version with the set name players see in that locale. App Store Connect rejects a locale the version already has.
app_store_connect.create_game_center_leaderboard_set_localizationGet Game Center Leaderboard Set Localization
Read one Game Center leaderboard set localization by its App Store Connect identifier.
app_store_connect.get_game_center_leaderboard_set_localizationUpdate Game Center Leaderboard Set Localization
Replace the set name of a Game Center leaderboard set localization, or clear it with null. The locale is fixed once the localization exists; delete and recreate it to change the locale.
app_store_connect.update_game_center_leaderboard_set_localizationDelete Game Center Leaderboard Set Localization
Remove a locale from a Game Center leaderboard set version, including the image uploaded for that locale.
app_store_connect.delete_game_center_leaderboard_set_localizationGet Game Center Leaderboard Set Localization Image
Read the image attached to one Game Center leaderboard set localization, with its delivery URL and upload state. Uploading an image is not covered by this connector; only an image that was already uploaded can be read.
app_store_connect.get_game_center_leaderboard_set_localization_imageList Game Center Leaderboard Set Member Localizations
List the member localizations of one leaderboard inside one leaderboard set. A member localization is the name a leaderboard is shown under while a player browses the set, which can differ from the name of the leaderboard on its own. App Store Connect requires both the set and the leaderboard.
app_store_connect.list_game_center_leaderboard_set_member_localizationsCreate Game Center Leaderboard Set Member Localization
Give one leaderboard a name of its own inside one leaderboard set, for one locale. Without a member localization the leaderboard keeps its usual localized name inside the set.
app_store_connect.create_game_center_leaderboard_set_member_localizationUpdate Game Center Leaderboard Set Member Localization
Replace the name a leaderboard is shown under inside a leaderboard set, or clear it with null so the leaderboard falls back to its usual localized name.
app_store_connect.update_game_center_leaderboard_set_member_localizationDelete Game Center Leaderboard Set Member Localization
Delete the name a leaderboard is shown under inside a leaderboard set for one locale. The leaderboard stays in the set and falls back to its usual localized name.
app_store_connect.delete_game_center_leaderboard_set_member_localizationList Game Center Detail Activities
List the Game Center activities of one app, reached through its Game Center detail record. App Store Connect offers no filters here, so page through the results with limit and cursor.
app_store_connect.list_game_center_detail_activitiesList Game Center Group Activities
List the Game Center activities shared by the apps of one Game Center group. App Store Connect offers no filters here, so page through the results with limit and cursor.
app_store_connect.list_game_center_group_activitiesCreate Game Center Activity
Create a Game Center activity for one app (gameCenterDetailId) or for a group of apps (gameCenterGroupId). Pass fallbackUrl to create the first activity version together with the activity; leave it out and no version is created, so add one afterwards with create_game_center_activity_version before the activity can be localized.
app_store_connect.create_game_center_activityGet Game Center Activity
Read one Game Center activity by its App Store Connect identifier.
app_store_connect.get_game_center_activityUpdate Game Center Activity
Change the configuration of a Game Center activity or archive it. Overwrites the given fields and passing null clears one; vendorIdentifier cannot change once the activity exists. Pass at least one field.
app_store_connect.update_game_center_activityDelete Game Center Activity
Delete a Game Center activity together with its versions, localizations and images. Archive it with update_game_center_activity instead when players may still hold invitations to it.
app_store_connect.delete_game_center_activityList Game Center Activity Versions
List the versions of one Game Center activity, each with its review and release state.
app_store_connect.list_game_center_activity_versionsAdd Achievements To Game Center Activity
Attach achievements to a Game Center activity so players can earn them while the activity is played. Achievements already attached are left as they are.
app_store_connect.add_achievements_to_game_center_activityRemove Achievements From Game Center Activity
Detach achievements from a Game Center activity. The achievements themselves are kept and stay available outside the activity.
app_store_connect.remove_achievements_from_game_center_activityAdd Leaderboards To Game Center Activity
Attach leaderboards to a Game Center activity so scores made while it is played are posted to them. Leaderboards already attached are left as they are.
app_store_connect.add_leaderboards_to_game_center_activityRemove Leaderboards From Game Center Activity
Detach leaderboards from a Game Center activity. The leaderboards themselves are kept together with the scores already posted to them.
app_store_connect.remove_leaderboards_from_game_center_activityCreate Game Center Activity Version
Create a new version of a Game Center activity, for example to change its localizations or its default image after the current version was released. The new version starts in PREPARE_FOR_SUBMISSION.
app_store_connect.create_game_center_activity_versionGet Game Center Activity Version
Read one Game Center activity version by its App Store Connect identifier.
app_store_connect.get_game_center_activity_versionUpdate Game Center Activity Version
Set or clear the fallback URL of a Game Center activity version. Overwrites the existing URL; pass null to remove it.
app_store_connect.update_game_center_activity_versionGet Game Center Activity Version Default Image
Read the default image of a Game Center activity version, shown wherever a locale has no image of its own. Returns null when no default image has been uploaded yet; uploading one is not covered by this connector.
app_store_connect.get_game_center_activity_version_default_imageList Game Center Activity Version Localizations
List the locales one Game Center activity version has text for.
app_store_connect.list_game_center_activity_version_localizationsCreate Game Center Activity Localization
Add a locale to a Game Center activity version with the name and description players see in it. App Store Connect rejects a locale the version already has.
app_store_connect.create_game_center_activity_localizationGet Game Center Activity Localization
Read one Game Center activity localization by its App Store Connect identifier.
app_store_connect.get_game_center_activity_localizationUpdate Game Center Activity Localization
Replace the name or the description of a Game Center activity localization, or clear one with null. The locale cannot change; delete the localization and create it again instead. Pass at least one field.
app_store_connect.update_game_center_activity_localizationDelete Game Center Activity Localization
Remove a locale from a Game Center activity version, including the image attached to it.
app_store_connect.delete_game_center_activity_localizationGet Game Center Activity Localization Image
Read the image of one Game Center activity localization. Returns null when the locale has no image of its own and falls back to the default image of the version; uploading an image is not covered by this connector.
app_store_connect.get_game_center_activity_localization_imageList Game Center Detail Challenges
List the challenges configured on the Game Center detail of one app, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_detail_challengesList Game Center Group Challenges
List the challenges shared by the games of one Game Center group, optionally narrowed by reference name, archived state or identifier.
app_store_connect.list_game_center_group_challengesCreate Game Center Challenge
Create a Game Center challenge on the Game Center detail of one app or on a group, scored on one leaderboard. The challenge starts without a version; create its first version with create_game_center_challenge_version and add the localized text to that version.
app_store_connect.create_game_center_challengeGet Game Center Challenge
Read one Game Center challenge by its App Store Connect identifier.
app_store_connect.get_game_center_challengeUpdate Game Center Challenge
Rename a Game Center challenge, archive it, change whether players may repeat it, or score it on another leaderboard. Overwrites the given fields; pass at least one. The vendor identifier and the challenge type cannot be changed after creation.
app_store_connect.update_game_center_challengeDelete Game Center Challenge
Delete a Game Center challenge together with all of its versions, localizations and images.
app_store_connect.delete_game_center_challengeList Game Center Challenge Versions
List the versions of one Game Center challenge, each with the review and release state it is in.
app_store_connect.list_game_center_challenge_versionsSet Game Center Challenge Leaderboard
Score a Game Center challenge on another leaderboard, replacing the leaderboard it used before. App Store Connect does not accept detaching the leaderboard, so a leaderboard identifier is always required.
app_store_connect.set_game_center_challenge_leaderboardCreate Game Center Challenge Version
Create a new version of a Game Center challenge, for example to change its localized text after the current version went live. The version starts empty; add its locales with create_game_center_challenge_localization.
app_store_connect.create_game_center_challenge_versionGet Game Center Challenge Version
Read one Game Center challenge version by its App Store Connect identifier.
app_store_connect.get_game_center_challenge_versionGet Game Center Challenge Version Default Image
Read the default image of a Game Center challenge version, the one shown for locales without their own image. Returns null when the version has no default image. Uploading an image is not covered by this connector.
app_store_connect.get_game_center_challenge_version_default_imageList Game Center Challenge Version Localizations
List the locales one Game Center challenge version carries text for.
app_store_connect.list_game_center_challenge_version_localizationsCreate Game Center Challenge Localization
Add a locale with the name and description players see to a Game Center challenge version. App Store Connect rejects a locale the version already has.
app_store_connect.create_game_center_challenge_localizationGet Game Center Challenge Localization
Read one Game Center challenge localization by its App Store Connect identifier.
app_store_connect.get_game_center_challenge_localizationUpdate Game Center Challenge Localization
Replace the name or the description of a Game Center challenge localization, or clear one of them with null. Overwrites the given fields; pass at least one. The locale cannot be changed, so replace the localization to move the text to another locale.
app_store_connect.update_game_center_challenge_localizationDelete Game Center Challenge Localization
Remove one locale from a Game Center challenge version, including the image attached to it.
app_store_connect.delete_game_center_challenge_localizationGet Game Center Challenge Localization Image
Read the image of one Game Center challenge localization, or null when the locale has no image of its own and falls back to the default image of the version. Uploading an image is not covered by this connector.
app_store_connect.get_game_center_challenge_localization_imageList Game Center Matchmaking Queues
List every Game Center matchmaking queue of the team, each with the rule set it matches requests with and the rule set of a running experiment.
app_store_connect.list_game_center_matchmaking_queuesCreate Game Center Matchmaking Queue
Create a Game Center matchmaking queue and attach the rule set its requests are matched with. Optionally attach a second rule set to experiment with, and list the bundle identifiers whose classic matchmaking requests should reach this queue.
app_store_connect.create_game_center_matchmaking_queueGet Game Center Matchmaking Queue
Read one Game Center matchmaking queue by its App Store Connect identifier, including the rule set it matches requests with and the rule set of a running experiment.
app_store_connect.get_game_center_matchmaking_queueUpdate Game Center Matchmaking Queue
Point a Game Center matchmaking queue at another rule set, change the rule set its experiment runs with, or replace the classic matchmaking bundle identifiers. Overwrites the given fields; pass at least one. The queue name cannot be changed after creation.
app_store_connect.update_game_center_matchmaking_queueDelete Game Center Matchmaking Queue
Delete a Game Center matchmaking queue. Requests the game sends to the deleted queue are no longer matched.
app_store_connect.delete_game_center_matchmaking_queueList Game Center Matchmaking Rule Sets
List every Game Center matchmaking rule set of the team, with the player limits and the rule language version each one uses.
app_store_connect.list_game_center_matchmaking_rule_setsCreate Game Center Matchmaking Rule Set
Create a Game Center matchmaking rule set with the player limits a match must stay within. Add its teams and rules afterwards with create_game_center_matchmaking_team and create_game_center_matchmaking_rule, then attach the rule set to a queue.
app_store_connect.create_game_center_matchmaking_rule_setGet Game Center Matchmaking Rule Set
Read one Game Center matchmaking rule set by its App Store Connect identifier.
app_store_connect.get_game_center_matchmaking_rule_setUpdate Game Center Matchmaking Rule Set
Change the player limits of a Game Center matchmaking rule set, or clear a limit with null. Overwrites the given fields; pass at least one. The rule set name and its rule language version cannot be changed.
app_store_connect.update_game_center_matchmaking_rule_setDelete Game Center Matchmaking Rule Set
Delete a Game Center matchmaking rule set together with its teams and rules. A queue that still points at the rule set stops matching requests.
app_store_connect.delete_game_center_matchmaking_rule_setList Game Center Matchmaking Rule Set Queues
List the matchmaking queues that match their requests with one rule set, either as their rule set or as their experiment rule set.
app_store_connect.list_game_center_matchmaking_rule_set_queuesList Game Center Matchmaking Rule Set Rules
List the rules of one Game Center matchmaking rule set, with the expression each rule evaluates for a candidate match.
app_store_connect.list_game_center_matchmaking_rule_set_rulesList Game Center Matchmaking Rule Set Teams
List the teams of one Game Center matchmaking rule set, with the player limits of each team.
app_store_connect.list_game_center_matchmaking_rule_set_teamsCreate Game Center Matchmaking Rule
Add a rule to a Game Center matchmaking rule set. The expression is evaluated for every candidate match: a COMPATIBLE, DISTANCE or TEAM rule decides whether the candidate is acceptable, and a MATCH rule scores it. Try the rule set with test_game_center_matchmaking_rule_set before attaching it to a queue.
app_store_connect.create_game_center_matchmaking_ruleUpdate Game Center Matchmaking Rule
Change the expression, the description or the weight of a Game Center matchmaking rule, or clear one of them with null. Overwrites the given fields; pass at least one. The rule name and its type cannot be changed.
app_store_connect.update_game_center_matchmaking_ruleDelete Game Center Matchmaking Rule
Delete a rule from its Game Center matchmaking rule set. Candidate matches are no longer checked against it.
app_store_connect.delete_game_center_matchmaking_ruleCreate Game Center Matchmaking Team
Add a team to a Game Center matchmaking rule set. Rule expressions refer to the team by its name, and Game Center fills the team with between minPlayers and maxPlayers players.
app_store_connect.create_game_center_matchmaking_teamUpdate Game Center Matchmaking Team
Change the player limits of a Game Center matchmaking team, or clear a limit with null. Overwrites the given fields; pass at least one. The team name cannot be changed, because rule expressions refer to it.
app_store_connect.update_game_center_matchmaking_teamDelete Game Center Matchmaking Team
Delete a team from its Game Center matchmaking rule set. Rule expressions that still refer to the team by name stop working.
app_store_connect.delete_game_center_matchmaking_teamTest Game Center Matchmaking Rule Set
Run a Game Center matchmaking rule set against a set of simulated requests and return the matches it would have formed, with the team each simulated player was assigned to. Nothing is stored and no real player is matched, so this is safe to run against a rule set that is already attached to a queue.
app_store_connect.test_game_center_matchmaking_rule_setGet Game Center Classic Matchmaking Request Metrics
Read the matchmaking requests an app made through classic (non rule based) matchmaking, as time series of request counts and queue wait times. Each data point covers the granularity you pass.
app_store_connect.get_game_center_classic_matchmaking_request_metricsGet Game Center Rule Based Matchmaking Request Metrics
Read the matchmaking requests an app made through rule based matchmaking, as time series of request counts and queue wait times.
app_store_connect.get_game_center_rule_based_matchmaking_request_metricsGet Game Center Matchmaking Queue Request Metrics
Read the matchmaking requests one queue handled, as time series of request counts and queue wait times, optionally split by result or by the app that sent the requests.
app_store_connect.get_game_center_matchmaking_queue_request_metricsGet Game Center Matchmaking Queue Size Metrics
Read how many requests were waiting in one matchmaking queue, as time series of average and percentile queue sizes.
app_store_connect.get_game_center_matchmaking_queue_size_metricsGet Game Center Matchmaking Queue Session Metrics
Read the matchmaking sessions one queue produced, as time series of session counts and of how many players each session held.
app_store_connect.get_game_center_matchmaking_queue_session_metricsGet Game Center Matchmaking Queue Experiment Request Metrics
Read the share of a queue's traffic that was matched with the experiment rule set, as time series of request counts and queue wait times. Compare it with get_game_center_matchmaking_queue_request_metrics to judge whether the experiment rule set is an improvement.
app_store_connect.get_game_center_matchmaking_queue_experiment_request_metricsGet Game Center Matchmaking Queue Experiment Size Metrics
Read how many requests were waiting in the part of a matchmaking queue served by the experiment rule set, as time series of average and percentile queue sizes.
app_store_connect.get_game_center_matchmaking_queue_experiment_size_metricsGet Game Center Matchmaking Rule Boolean Result Metrics
Read how often one matchmaking rule returned each boolean result, as time series of evaluation counts.
app_store_connect.get_game_center_matchmaking_rule_boolean_result_metricsGet Game Center Matchmaking Rule Number Result Metrics
Read the values one matchmaking rule expression returned, as time series of evaluation counts with average and percentile results.
app_store_connect.get_game_center_matchmaking_rule_number_result_metricsGet Game Center Matchmaking Rule Error Metrics
Read how often one matchmaking rule failed to evaluate, as time series of error counts.
app_store_connect.get_game_center_matchmaking_rule_error_metrics検索条件に一致する操作はありません。
App Store Connect を Open Flow に接続
毎月 20,000 回のアプリ呼び出しが無料(有料サービスは別途課金)