Using the AppBrain API for promotion campaigns

With the AppBrain API you can create, update and get information about your promotion campaigns.

Your programs can use the API by sending HTTP requests to https://api.appbrain.com.

You can send three types of HTTP requests to the API. The syntax is explained in the AppBrain API specification. On that page you can also immediately try out the API if you have an AppBrain developer account with API access.

All requests require a developer account with API access, and the query parameter apikey must be included for authentication. See the dashboard for more information.

By default, responses are sent in JSON format. If you want the response to be in XML format instead, then please add format=xml to your request.

Get campaign

Retrieve all available information about a promotion campaign (state, budget limits, etc).

https://api.appbrain.com/v2/campaigns/get

The query parameter for this request is:

  • package: the package name of your app.

List campaigns

Get the names of all your campaigns regardless of what a campaign’s status is (whether it’s active, stopped or paused).

https://api.appbrain.com/v2/campaigns/list

Update campaign

Create a new campaign or update the information about an existing one.

https://api.appbrain.com/v2/campaigns/update

An optional query parameter for this request is:

  • lowbidaction: what to do if the CPI bid that you set for a country is lower than the minimum allowed bid.

    • ERROR returns an error

    • RAISE raises your bid to the mandatory minimum

    • STOP stops the campaign in the country

    By default, an error message is returned if your CPI bid is lower than what is allowed.

The body parameters for this request are:

  • package: the package name of your app.

  • state: the state of the campaign. If you’re creating a new campaign, then the state is automatically set to RUNNING.

  • title: the main promotion title of your campaign. It can be up to 30 characters. If you don’t specify one, your app’s name will be used.

  • subtitle: the subtitle of your campaign. It can be up to 80 characters. If you don’t specify one, your app’s short description is used. If you don’t have that, your app’s full description (up to the first 80 characters) is used.

  • dailyBudget: the daily cost limit in dollars that you set for your campaign. If you don’t want a daily limit, then leave out the parameter or set the value to negative.

  • remainingBudget: the total cost limit in dollars that you set for your campaign. If you don’t want any limits, then leave out the parameter or set the value to negative.

  • installTracking: the attribution partner that is used for install tracking.

  • clickthroughUrl: the clickthrough URL to track the installs driven to your campaign. This URL must be valid for the attribution partner and redirect to the Google Play page of the package.

  • countries: the list of countries in which you want to run your campaign. Setting this list overwrites all country settings for the campaign. This can’t be used simultaneously with updateCountries or removeCountries.

    Each country contains the following fields:

    • code: the two letter ISO code of the country. You can get a list with all country codes by using the getcountries API request.

    • cpi: the maximum price you are willing to pay for an install in the country.

  • updateCountries: can be used to update settings (code, cpi and clickthroughUrl) for countries instead of providing a full list to replace all countries. This can’t be used simultaneously with countries.

  • removeCountries: specifies countries that you want to remove from your campaign. This can’t be used simultaneously with countries.

When creating a new campaign, the information that you must always include in the body of your request are: your app’s package name and at least one country with its code and cpi.

You can use the API by default for apps that are active on your AppBrain dashboard. If you don’t have apps published on Google Play and want an account to promote 3rd-party apps, please contact us at contact@appbrain.com to get access to the API.