In the Catalog Reports module in iTunes Connect, you can request and download reports that detail the metadata and configurations for the iTunes Connect information for your organization’s catalog of apps, including apps, In-App Purchase products, and metadata for Game Center leaderboards and achievements.
Each report includes all available information for an organization.
Each type of catalog report can be run as often as once per 24-hour period. Reports are available for 30 days after they are posted and are formatted as tab-delimited text files.
Requesting Catalog Reports
The team agent and any users with an Admin, Technical, or Finance role can view catalog reports.
When the request is successful, a message states that you’ll receive an email when the report is ready to be downloaded. If one or more of the reports requested has already been requested in the current 24-hour period, a message indicates that the report or reports won’t be run again.
Viewing Catalog Reports
Reports that are ready to view and download appear on the Catalog Reports page. The report downloads as a tab-delimited
.txt
file.Catalog Report Content
The first row of a catalog report is a header row that includes the names of each column in the report. The following sections list each column name, the corresponding name used in iTunes Connect, and a short description of the content. For more information, see “iTunes Connect App Properties.”
App Catalog Report
The app-specific catalog report includes a row for each version of each app in your organization.
Catalog report column
|
iTunes Connect name
|
Description
|
---|---|---|
APPLE_ID | Apple ID | The unique Apple ID assigned to the app. |
APP_NAME | App Name | The name of the app. |
APP_TYPE | App Type | The operating system the app supports. This value can be “iOS” or “Desktop.” |
PRIMARY_LANGUAGE | Default Language | The default language for the app. App metadata and assets are displayed in this language in all store territories unless localized information for individual territories is provided. |
SKU | SKU Number | A unique UTF-8 alphanumeric identifier specified when the app was first registered in iTunes Connect. This identifier is unique to your organization and can’t be edited. |
VERSION_STRING | Version | The version of the app. |
ITC_STATUS | Status | The current status of this version of the app. See Table 9-1 for a list of statuses. |
LATEST_STATUS_CHANGE_DATE | Status Change Date | The date on which the app status last changed. |
RATING | Rating | The age rating assigned to the app. This rating is used by parental controls and provides a guideline for the age suitability of an app. The four rating categories are 4+, 9+, 12+, and 17+. |
PRIMARY_GENRE | Primary Category | The primary category used by the store to list the app. |
SECONDARY_GENRE | Secondary Category | The secondary category used by the store to list the app. |
COUNT_IN_APP_APPROVED | Approved In-App Purchase Products | The number of In-App Purchase products that have been approved for sale for the app. |
BUNDLE_IDENTIFIER | Bundle ID | The unique app identifier you have registered with Apple. Bundle IDs are specific to the app’s type, iOS or OS X. |
BUNDLE_VERSION | Bundle Version String | The version of the bundle. |
BUNDLE_DEVICE_FAMILY | Device Family | The devices that the app works on. Valid iOS devices are: iPhone Only, iPad Only, or Universal. Mac apps show Desktop in this field.
Note: If the app has the “Prepare for Upload” status, this entry is blank.
|
MINIMUM_OS_VERSION | Minimum OS | The minimum operating system required for this app to work. |
BUNDLE_LOCALIZATIONS | Bundle Localization (.lproj folders) | A list of languages that the bundle has localization information for. |
PRE_RENDERED_ICON | Prerendered Icon Setting | An indication of whether the iOS app has a prerendered icon. A “Y” in the column means it’s prerendered.
This field is used by iOS apps only.
|
CURRENT_PRICE_TIER | Current Price Tier | An indication of the current price tier of the app in the store. |
iAD_ENABLED | iAd Enabled | An indication of whether the app is enabled to use the iAd App Network. A “Y” in the column means it’s enabled. |
GAME_CENTER_ENABLED | Game Center Enabled | An indication of whether Game Center is enabled. A “Y” in the column means it’s enabled. |
NEWSSTAND_ENABLED | Newsstand Enabled | An indication of whether Newsstand is enabled. A “Y” in the column means it’s enabled. |
APPROVED_LEADERBOARD_COUNT | Approved Game Center Leaderboards | The number of approved leaderboards the app contains. |
APPROVED_ACHIEVEMENT_COUNT | Approved Game Center Achievements | The number of approved achievements the app contains. |
List of languages | Added Localizations | The languages that the iTunes Connect record includes localized metadata for. A “Y” in a column denotes that the app has been localized for that language. If the column is blank, there’s no localized metadata for that language.
The report includes a column with each possible language.
|
List of country codes | Territory Clearances | The store territories that the app is listed in. A “Y” denotes that the app is listed as available for sale in that territory. If the column is blank, the app isn’t available in that territory.
The report includes a column with the two-letter code for each possible territory.
|
In-App Purchases Catalog Report
The In-App Purchases catalog report includes a row for each of the In-App Purchase products associated with apps in your organization.
Catalog report column
|
iTunes Connect name
|
Description
|
---|---|---|
Apple_ID | In-App Purchase Apple ID | The unique Apple ID assigned to your In-App Purchase product. |
REFERENCE_NAME | In-App Purchase Reference Name | The reference name that’s used in iTunes Connect for the product. This name isn’t displayed in the store. |
PRODUCT_ID | In-App Purchase Product ID | A unique identifier used for reporting. |
ADDON_TYPE | In-App Purchase Type | The type of In-App Purchase product. The type can be one of the following: Consumable, Non-Consumable, Auto-Renewable Subscription, Free Subscription, or Non-Renewing Subscription. |
ADDON_ITC_STATUS | In-App Purchase iTunes Connect Status | The current state of the product. |
CURRENT_PRICE_TIER | Current In-App Purchase Price Tier | The pricing tier associated with the product. |
AUTO_RENEWABLE_DURATION | Auto-Renewable Duration | The length of time between auto-renewals. The duration can be 7 days, 1 month, 2 months, 3 months, 6 months, or 1 year. |
FREE_TRIAL_DURATION | Free Trial Duration | The length of time of the free trial. |
MARKETING_OPTIN_INCENTIVE_DURATION | Marketing Opt-In Incentive Duration | An indication of whether there’s a free subscription extension if users opt in to share their contact information with you for marketing purposes. |
CLEARED_FOR_SALE | Cleared for Sale Setting | An indication of whether the product is ready for sale. An “N” indicates the product is not available for purchase within the app. |
APP_NAME | App Name (Parent App) | The name of the app that the product is associated with. |
APP_APPLE_ID | App Apple ID (Parent App) | The Apple ID of the app that the product is associated with. |
List of languages | Added Localizations | The languages that the iTunes Connect record for the product is localized for. A “Y” in a column denotes that the product has been localized for that language. If the column is blank, there isn’t localized metadata for that language.
The report includes a column with each possible language.
|
Game Center Leaderboard Catalog Report
The Game Center Leaderboard catalog report includes a row for each of the leaderboards associated with apps in your organization.
Catalog report column
|
iTunes Connect name
|
Description
|
---|---|---|
APP_APPLE_ID | Apple ID | The unique Apple ID assigned to your app. |
REFERENCE_NAME | Leaderboard Reference Name | The internal name for the leaderboard as specified when the leaderboard is first configured in iTunes Connect. |
APP_NAME | App Name | The name of the app that contributes to the leaderboard.
If the leaderboard is for an app that’s in a group, this column lists the names of all apps in the group.
|
LEADERBOARD_ID | Leaderboard ID | The alphanumeric identifier for the leaderboard. |
SCORE_FORMAT_TYPE | Score Format Type | The type of format that scores are expressed in for this leaderboard. |
Display_Order | Display Order | The position in which this leaderboard appears in the list of leaderboards for the app. |
SORT_ORDER | Sort Order | The leaderboard sort order. Scores can display from low to high or high to low. |
MIN_SCORE_RANGE | Score Range | The minimum allowable score for the leaderboard, if set. |
MAX_SCORE_RANGE | Score Range | The maximum allowable score for the leaderboard, if set. |
PARENT_LEADERBOARD | Parent Leaderboard Reference Name | The Leaderboard Reference Name of the parent leaderboard if this leaderboard is a child in a combined leaderboard. |
LEADERBOARD_STATUS | Leaderboard Status | The current status of the leaderboard. The following definitions apply for each status:
|
IS_DEFAULT | Default | An indication that this leaderboard is the first leaderboard that users see in Game Center. |
GROUP | Group Reference Name | The name of the group that the app is part of, if any. |
LEADERBOARD_TYPE | Leaderboard Type | The type of leaderboard. The following definitions apply for each type:
|
LOCALIZATIONS | Languages | A comma–separated list of the languages that have been set up for the leaderboard. |
Game Center Achievement Catalog Report
The Game Center Achievement catalog report includes a row for each of the achievements associated with apps in your organization.
Catalog report column
|
iTunes Connect name
|
Description
|
---|---|---|
APP_APPLE_ID | Apple ID | The unique Apple ID assigned to your app. |
REFERENCE_NAME | Achievement Reference Name | An internal name for the achievement. This name is set when the achievement is first configured in iTunes Connect. |
APP_NAME | App Name | The name of the app that contains the achievement.
If the achievement is for an app in a group, this column lists the names of the apps in the group.
|
ACHIEVEMENT_ID | Achievement ID | The alphanumeric identifier for the achievement as set when the achievement is first configured in iTunes Connect. |
Display_Order | Display Order | The position in which this achievement appears in the list of achievements for the app. |
POINTS_VALUE | Point Value | The number of points that the achievement is worth, with a maximum of 100 points per achievement and 1000 points per app. |
IS_HIDDEN | Hidden | An indication that the achievement is hidden from the player until the player meets the achievement’s requirements. |
IS_RECYCLABLE | Achievable More than Once | An indication that the achievement can be earned multiple times. |
GROUP | Group Reference Name | The name of the group that the app is part of, if any. |
ACHIEVEMENT_STATUS | Achievement Status | The current status of the achievement. The following definitions apply for each status:
|
LOCALIZATIONS | Languages | A comma–separated list of the languages that have been set up for the achievement. |
No comments:
Post a Comment