Getting started

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

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 AARs.

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.+'
implementation 'co.ogury:ogury-mediation-xandr:1.+'
}

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

Manual Integration

Download 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 and xandrevents-X.X.X by the name of the downloaded AARs.

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

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

Step 3: Initialize the Ogury SDK

This step is optional unless you are using the Ogury Choice Manager.

After you have registered your app and imported the Ogury SDK, you must call Ogury.start() before you use Ogury Choice Manager.

Java
Java
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 and initialize Ogury Ads

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. By default, the consent collection is operated by the Ogury Choice Manager. This turnkey solution streamlines the consent management for Ogury and any other of your partner, helping you to be fully compliant with the regulation.

All you need to do is to integrate the Ogury Choice Manager, and everything is then managed on your behalf, from the consent notice disclosure to the ongoing GDPR compliance.

In order to collect user consent, follow the Ogury Choice Manager guide.

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 validated 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.

If you already have your own consent notice to collect user consent, we provide a procedure to transmit the consent to us.

Step 5: Integrate Ogury ad formats

Congratulations, the Ogury SDK is now initialized! You are now ready to integrate your first ad. Ogury provides two different ad formats, (i) Interstitial Ads and (ii) Banner 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.