Getting started

This documentation will go through all the steps required to display Ogury ads on Android platform.

From October 2020, Ogury released a new API specially refactored to improve the onboarding experience. If you have already integrated the Ogury SDK and want to update your integration with the latest API, you can read the Migration guide. It explains the main points to easily switch from the old API to the new one.

Step 1: Register your application

The Asset Key follows the pattern: OGY-XXXXXXXXXXXX, where X is an uppercase letter or digit. In all the following code samples, we will refer to this Asset Key by using the string OGY-XXXXXXXXXXXX.

Step 2: Import the Ogury SDK

To import the latest version of the Ogury SDK into your project, Ogury provides two methods:

  • Automated integration using Ogury's Maven repository (recommended).

  • Manual integration of the Ogury SDK AAR.

Maven repository
Manual integration
Maven repository

Configure your IDE

Open the build.gradle of your application and add the following lines:

repositories {
maven {
url 'https://maven.ogury.co'
}
}
dependencies {
implementation 'co.ogury:ogury-sdk:5.+'
}

To know more about the latest release of the Ogury SDK, you can check the release notes.

Manual integration

Download the Ogury SDK

Configure your IDE

Open the build.gradle of your application and add the following lines, making sure to replace ogury-sdk-X.X.X by the name of the downloaded AAR.

repositories {
flatDir {
dirs 'libs'
}
}
dependencies {
implementation(name: 'ogury-sdk-X.X.X', ext: 'aar')
}

To know more about the latest release of the Ogury SDK, you can check the release notes.

Step 3: Initialize the Ogury SDK

After you have registered your app and imported the Ogury SDK, you must call Ogury.start() before you use any Ogury's functionalities.

OguryConfiguration.Builder oguryConfigurationBuilder = new OguryConfiguration.Builder(this, "OGY-XXXXXXXXXXXX");
Ogury.start(oguryConfigurationBuilder.build());

The start method takes an OguryConfiguration object as parameters. The OguryConfiguration is built from its Builder which takes the following parameters:

  • the Application context.

  • the Asset Key of your application. If you do not have one yet, you can refer to the first step to create it.

Step 4: Collect the user consent

The European GDPR regulation requires obtaining the users' consent in order to display them personalized ads, (i) when the company processing personal data is based in the EU, or (ii) when the users are EU citizens.

As a company based in the EU, Ogury accordingly requires an explicit consent from the users to collect their personal data and display them personalized ads. The consent collection can be operated:

Note that the Ogury SDK meets privacy requirements by design. Shall it not receive a valid consent status from the Ogury Choice Manager or from a third-party consent solution, it will display an End User License Agreement (EULA) before serving the first ad. Another way to put it: no targeted ad will be displayed to the users if they didn't give their consent first.

Step 5: Integrate Ogury ad formats

Ogury provides four different ad formats, (i) Interstitial Ads, (ii) Opt-in Video Ads, (iii) Banner Ads, and (iv) Thumbnail Ads. You can refer to the following sections to proceed with the integration:

We suggest you setup a test device before you start integrating so that the device configuration has time to propagate while you perform your integration.

Before going live

Ogury is part of the IAB Authorized Sellers for Apps initiative to fight inventory fraud for applications. It is recommended to update your app-ads.txt to include Ogury as described in the app-ads.txt section.