| package | The Android application ID (package name) for your app as registered in Google Play Console. This is typically in reverse domain format like 'com.example.myapp'.
| yes | — |
| serviceAccountJsonPath | Path to the Google Cloud service account JSON key file within your repository or runner environment. This should point to a file containing the service account credentials with Google Play Console API access. If both serviceAccountJsonPath and serviceAccountJsonPlainText are provided, this path will take precedence. Example: 'path/to/service-account.json'
| no | — |
| serviceAccountJsonPlainText | The complete Google Cloud service account JSON key content as a plain text string. This is useful when storing the credentials as a GitHub Secret rather than committing the file. The JSON should include all required fields: type, project_id, private_key_id, private_key, client_email, etc. This will be ignored if serviceAccountJsonPath is provided.
| no | — |
| tracks | Specify which release tracks to include in the output data. Use 'all' to include all tracks, or provide a comma-separated list of specific tracks. Supported tracks: internal, alpha, beta, production. Each track contains release information including version codes, release notes, and status. Example: 'production,beta' or 'all'
| no | — |
| apks | Set to 'true' to include APK information in the output. This retrieves details about uploaded APK files including version codes, file sizes, and binary information. Useful for tracking APK versions and properties across different releases.
| no | false |
| bundles | Set to 'true' to include Android App Bundle (AAB) information in the output. This retrieves details about uploaded App Bundle files including version codes and bundle properties. App Bundles are the preferred publishing format for optimized app delivery.
| no | false |
| listings | Set to 'true' to include store listing information for all supported languages. This retrieves app titles, descriptions, and other localized store listing content. Useful for auditing or backing up your app's store presence across different markets.
| no | false |
| images | Specify which store listing images to include in the output data. Use 'all' to include all image types, or provide a comma-separated list of specific image types. Supported types: icon, featureGraphic, promoGraphic, tvBanner, phoneScreenshots, sevenInchScreenshots, tenInchScreenshots, tvScreenshots, wearScreenshots. Example: 'icon,featureGraphic,phoneScreenshots' or 'all'
| no | — |
| inapps | Set to 'true' to include in-app product information in the output. This retrieves details about in-app purchases, subscriptions, and other monetization products configured for your app, including pricing, status, and localized descriptions.
| no | false |
| reviews | Set to 'true' to include user reviews and ratings in the output. This retrieves recent user reviews with ratings, comments, and metadata. Use reviewsPages and reviewsPageSize to control how many reviews are fetched.
| no | false |
| voidedPurchases | Set to 'true' to include information about voided (refunded) purchases. This retrieves details about cancelled or refunded transactions, useful for financial reconciliation and understanding refund patterns.
| no | false |
| testers | Specify which tester groups to include in the output data. Use 'all' to include all tester groups, or provide a comma-separated list of specific tracks. Supported tracks: internal, alpha, beta, production. This retrieves information about users enrolled in testing programs for each track. Example: 'alpha,beta' or 'all'
| no | — |
| appDetails | Set to 'true' to include general app details and metadata. This retrieves core app information such as default language, contact email, and other administrative details configured in the Play Console.
| no | false |
| expansionFiles | Set to 'true' to include expansion file information for APKs. Expansion files are additional asset files that can be associated with APKs to exceed the standard APK size limit. This retrieves expansion file metadata and references.
| no | false |
| imagesLanguage | Specify the language/locale for retrieving store listing images. Use standard language-country codes (e.g., 'en-US', 'es-ES', 'fr-FR'). If not specified, images from the default language will be retrieved. Note that not all image types may be available in all languages.
| no | — |
| reviewsPages | Number of review pages to fetch when reviews are enabled. Each page contains a number of reviews determined by reviewsPageSize. Higher values retrieve more reviews but increase API usage and response time. Default behavior fetches a reasonable number of recent reviews.
| no | — |
| reviewsPageSize | Number of reviews per page when fetching review data. Controls the batch size for review retrieval. Typical values range from 10-100. Larger page sizes reduce API calls but increase memory usage and response time. Must be used in conjunction with reviewsPages to control total review count.
| no | — |
| all | Set to 'true' to automatically include all supported resources in the output. This is equivalent to setting tracks='all', apks='true', bundles='true', listings='true', images='all', inapps='true', reviews='true', voidedPurchases='true', testers='all', appDetails='true', and expansionFiles='true'. Individual resource flags will override this setting if explicitly specified.
| no | false |
| uploadOutputsArtifact | Set to 'true' to upload the complete output data as a GitHub Actions artifact. This creates a downloadable JSON file containing all fetched Play Console data, useful for archiving, debugging, or processing the data in subsequent workflow steps. The artifact will be available in the workflow run's artifacts section.
| no | false |
| outputsJsonPath | Directory path where the combined outputs JSON file should be written. If uploadOutputsArtifact is enabled and this is empty, a temporary path will be used. The file will contain all fetched data in a structured JSON format. Example: 'outputs/' will create 'outputs/play_console_outputs.json'
| no | artifacts/ |
| outputsArtifactName | Custom name for the uploaded artifact when uploadOutputsArtifact is enabled. This name will appear in the GitHub Actions artifacts list and be used for the download filename. Should be descriptive and unique within your workflow to avoid conflicts.
| no | play-console-outputs |
| outputsArtifactRetentionDays | Number of days to retain the uploaded artifact before automatic deletion. Valid range is 1-90 days. Lower values save storage costs, higher values provide longer data retention for historical analysis or debugging purposes. Consider your organization's artifact retention policies when setting this value.
| no | 1 |