Getting started
This documentation will go through all the steps required to display Ogury ads on iOS platform.
From 28th January 2022, 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 CocoaPods repository (recommended).
  • Manual integration of the Ogury SDK.
CocoaPods

Configure your Podfile

Open the Podfile of your application and :
  • Add the following lines into your target:
pod 'OgurySdk'
If you are using Xcode 12+, please use CocoaPods 1.10+ to avoid build errors due to the migration of our SDK to XCFramework.
To know more about the latest release of the Ogury SDK, you can check the release notes.

Step 3: Configure your application

In your project Build Settings, do the following changes:
  • add the -ObjC flag to Other Linker Flags.

Step 4: 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.
Swift
Objective-C
let configuration = OguryConfigurationBuilder(assetKey: "OGY-XXXXXXXXXXXX").build()
Ogury.start(with: configuration)
OguryConfigurationBuilder *configurationBuilder = [[OguryConfigurationBuilder alloc] initWithAssetKey:@"OGY-XXXXXXXXXXXX"];
[Ogury startWithConfiguration:[configurationBuilder build]];
The start method takes the following parameter:
  • a configuration object initialized with the Asset Key of your application. If you do not have one yet, you can refer to the first step to create it.

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 receive no 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.

Step 6: Integrate our 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:

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.

Integration Sample

Checkout our sample applications in our GitHub repository.
Last modified 1mo ago
Copy link
On this page
Step 1: Register your application
Step 2: Import the Ogury SDK
Step 3: Configure your application
Step 4: Initialize the Ogury SDK
Step 5: Collect the user consent
Step 6: Integrate our ad formats
Before going live
Integration Sample