AdAdapted Swift iOS SDK

New swift edition of the iOS SDK for AdAdapted.
Explore the docs »

Report Bug or Request Feature

Table of Contents

• About the Project
• Getting Started
• CoCoa Pod
• Contributing
• License
• Contact

About The Project

This SDK is used for implementing the AdAdapted ad views, keyword interception, ad event tracking, and deeplinking features.

Getting Started

To get a local copy up and running simply download the source code and run it through one of the target sample apps (SwiftExample and ObjcExample). You'll also need to input your own API key in the example app AppDelegates respectively. After that, you should start seeing ads and intercepts on the following 'List Page' of the sample apps (assuming your API key has a corresponding ad campaign enabled).

AASDK.startSession(withAppID: "YOUR_API_KEY", registerListenersFor: self, options: options)

CoCoa Pod

Alternatively the SDK is available via CoCoa Pod and can be directly imported and used within your own apps.

Once you have CoCoa Pods installed and integrated with your project, you can udpate your podfile to include the 'AASwiftSDK' pod:

# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'

target 'AASwiftExampleApp' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  pod 'AASwiftSDK'

end

Then after opening the .xcworkspace version of your project, you should see the newly imported AASwiftSDK within your project structure.

Contributing

When contributing please follow the guidelines below:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (using conventional commits [https://www.conventionalcommits.org/en/v1.0.0-beta.4/]) (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

When a new Pod release is needed, perform the following:

Create a new version

git tag X.X.X

Push the new version tag

git push origin X.X.X

Update the version within the AASwiftSDK.podspec

spec.version      = "X.X.X"

Push changes

pod trunk push

License

Copyright (c) 2020-present, AdAdapted, Inc. All rights reserved.

You are hereby granted a non-exclusive, worldwide, royalty-free license to use, copy, modify, and distribute this software in source code or binary form for use in connection with the web services and APIs provided by AdAdapted.

As with any software that integrates with the AdAdapted platform, your use of this software is subject to AdAdapted's terms and conditions [https://info.adadapted.com/terms]. This copyright notice shall be included in all copies or substantial portions of the software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contact

Brett Clifton - [[email protected]]