Amazon Update Plugin Integration Guide

Introduction

The Amazon Update Plugin automates the process of submitting your APK to the Amazon Appstore. This guide will help you integrate the plugin into your Gradle build process, configure it for your project, and successfully upload your APKs to the Amazon Appstore.

Benefits

Automates APK submission to Amazon Appstore
Handles authentication and token management seamlessly
Supports multiple API retries and caching for smoother updates
Fully configurable for different projects

Prerequisites

Java Development Kit (JDK) version 17 or higher
Gradle 6.7 or later
Amazon Appstore Developer account credentials

Installation Instructions

Step-by-Step Integration into the Application

Step 1: Adding the Plugin to Your Project

Create a amazon-release.gradle File in the app/ Directory:

Add a file named amazon-release.gradle in your app/ directory with the following content:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.brightdata:amazon-update-gradle:1+'
    }
}

apply plugin: com.brightdata.AmazonUpdatePlugin

// your amazon credentials are required
// for the plugin to work properly
amazonUpdate {
    clientId = 'YOUR_CLIENT_ID'
    clientSecret = 'YOUR_CLIENT_SECRET'
    releaseNotes = 'Bug fixes and improvements.'
    apkPath = 'build/outputs/apk/release/app-release.apk'
}

Register plugin in app/build.gradle:

Add the following lines to your app/build.gradle file:
```
apply from: 'amazon-release.gradle'
```

Step 2: Verifying the Integration

To upload your APK to the Amazon Appstore, run the following Gradle task:

./gradlew releaseToAmazon

Explanation:

amazon-release.gradle in app/ Directory: This file contains the configuration and application of the Amazon Update Plugin.
Register tasks: By adding the specified lines in app/build.gradle, you make plugin tasks available, so you can use them in your pipeline.

Plugin Configuration

Basic Configuration

Modify amazonUpdate configuration block values to override defaults:

clientId: Your Amazon Appstore client ID
clientSecret: Your Amazon Appstore client secret
releaseNotes: Release notes for the update
apkPath: The path to your APK file
cacheDir: Directory to store cached files (optional)

Using the Plugin

Checking for Updates

The plugin will automatically check for the latest SDK version based on the provided configuration.

Updating the Plugin

If version is set to "latest", and a newer version is available, the plugin will download and replace the existing SDK files.

Backward Compatibility

The plugin supports backward compatibility with older SDK versions, allowing you to switch between versions as needed.

Documentation

For more detailed information, please refer to the Amazon Update Gradle Plugin Documentation.

Best Practices

Regular Updates: Run your gradle with --refresh-dependencies to keep your plugins up-to-date with the latest features and bugfixes.

FAQ

Common Questions

Here are some common questions and answers about the Amazon Update Plugin:

Q: What if my upload fails?
A: Ensure your credentials are correct, and check for any error messages in the console. The plugin will retry automatically up to the configured number of retries.
Q: How do I handle multiple APKs?
A: The plugin is designed for single APK uploads. For multiple APKs, you'll need to configure separate tasks for each APK.
Q: What should I do if I encounter issues?
A: Check the plugin documentation and ensure you are using the latest version. If issues persist, contact support.

Support

If you need further assistance, please contact our support team at sdk@brightdata.com.

Conclusion

We hope this guide has helped you integrate the Amazon Update Plugin into your project.By following the steps outlined, you can completely automate your Amazon updates. If you have any questions or need further assistance, please refer to the documentation or contact our support team.

Sections