Getting started

This documentation will guide you through all the steps needed to display Ogury ads on the iOS platform.

Prerequisites

• Xcode version: 15 or later.

• Target iOS version: 12 or later.

Step 1: Register your application

• Log into your Ogury's publisher platform.

• Register your application and save your asset key.

The asset key follows the format: OGY-XXXXXXXXXXXX, where X represents an uppercase letter or digit. In the code samples provided, we will use the placeholder string OGY-XXXXXXXXXXXX to refer to this asset key.

Step 2: Import the Ogury SDK

To import the latest version of the Ogury SDK into your project:

• Open your application's Podfile.

• Add the following line to your target:

pod 'OgurySdk'

For details on the latest Ogury SDK release, please refer to the release notes.

Step 3: Configure your application

In your project's Build Settings, make the following changes:

• Add the -ObjC flag to the Other Linker Flags section.

Step 4: Initialize the Ogury SDK

When using a Consent Management Platform (CMP), it is recommended to wait for the CMP to establish the consent status before initializing the Ogury SDK.

When your app is registered and the Ogury SDK is imported, initialize it by calling Ogury.start() before accessing any Ogury SDK functionalities.

Swift

Ogury.start(with: "OGY-XXXXXXXXXXXX") { success, error in
    guard error == nil, success else {
        // handle error here
        return
    }
    // handle start here
}

Objective-C

[Ogury startWith:@"OGY-XXXXXXXXXXXX" completionHandler:^(BOOL success, OguryError * _Nullable error) {
    if (error) {
        // handle the error
    } else if (success) {
        // handle start here
    }
}];

The start method requires the Ogury asset key associated with your app. If you have not an asset key yet, please refer to the first step to create one.

Though optional, the StartCompletionBlock is recommended. It provides callbacks for successful initialization or errors. If initialization fails, the listener returns an OguryError with an error code and localizedDescription, helping you troubleshoot. The possible errors are defined in the OguryStartErrorCode enum for easy reference.

OguryStartErrorCode

Enum value	Description
ModuleMissing	The SDK could not be started because a required SDK module is missing.
ModuleFailedToStart	The SDK could not be started because one of the required SDK modules failed to start.

Step 5: Integrate Ogury ad formats

Ogury offers four distinct ad formats. You can refer to the following sections to proceed with the integration:

• Interstitial
• Rewarded
• Small Banner / MREC
• Thumbnail

Before going live

Ogury is part of the IAB Authorized Sellers for Apps initiative to fight inventory fraud for applications. It is recommended that you update your app-ads.txt file to include Ogury.