You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,10 @@ Teads allows you to integrate a single SDK into your app, and serve premium bran
12
12
13
13
The best way to see the working integration is to clone this repository, open it with Xcode, and run the project. The sample contains multiples kinds of integrations from direct integration to integrations using mediations partners such as AdMob, Mopub, Smart.
14
14
15
-
--
16
15
17
16
# Direct integration
18
17
19
-
*For setup through mediation partners check those [steps](#setup-for-mediations).*
18
+
*To setup through mediation partners check those [steps](#setup-for-mediations).*
20
19
21
20
22
21
## Install the Teads SDK iOS framework
@@ -25,25 +24,25 @@ Teads SDK is currently distributed through CocoaPods. It includes everything you
25
24
26
25
### Cocoapods
27
26
28
-
For installing TeadsSDK just put this on your podfile, if you never use cocoapods before please check the [offical documentation](https://guides.cocoapods.org/using/using-cocoapods.html).
27
+
To install the TeadsSDK just put this on your podfile, if you've never used cocoapods before please check the [offical documentation](https://guides.cocoapods.org/using/using-cocoapods.html).
29
28
30
29
```ruby
31
30
pod 'TeadsSDK', '~> 5.0'
32
31
```
33
32
34
-
Go to the directory containing your project's `.xcodeproj` file and the Podfile, on the terminal and run `pod install` command. This will install Teads SDK along with our needed dependencies.
33
+
On your terminal, go to the directory containing your project's `.xcodeproj` file and your Podfile and run `pod install` command. This will install Teads SDK along with our needed dependencies.
35
34
36
-
```
37
-
$ pod install -repo-update
35
+
```bash
36
+
pod install --repo-update
38
37
```
39
38
40
39
## Migrating from v4 to v5
41
40
42
-
In the v5 of the SDK, we've introduced a new class called `TeadsInReadAdPlacement` which is responsible of configuring the ad request and then make the call.
41
+
In SDK's v5, we've introduced a new class called `TeadsInReadAdPlacement` which is responsible of configuring the ad request and then make the call.
43
42
44
43
### Rename your ad view
45
44
46
-
From now on, we have replaced the old class `TFAInReadAdView` with a new one called `TeadsInReadAdView`. So you just need to rename it, in code and do not forget your storyboards if you are using it.
45
+
We've replaced the old class `TFAInReadAdView` with a new one called `TeadsInReadAdView`. All you need to do is renaming it (don't forget your storyboard or nib files if needed).
**(Optional)**Pass configurations to the adPlacement, note this could be mandatory if your app have to manage the privacies consent, more details about [TeadsAdPlacementSettings](#teadsadplacementsettings).
80
+
**(Optional)**Add settings to the adPlacement initialization parameters, note this could be mandatory if your app have to manage the privacies consent, more details about [TeadsAdPlacementSettings](#teadsadplacementsettings).
82
81
83
82
```swift
84
83
let pSettings = TeadsAdPlacementSettings { (settings) in
@@ -92,7 +91,7 @@ For more information about the user privacies consent, see this [documentation]
92
91
--
93
92
### Request an Ad
94
93
95
-
You can then request an ad using the placement you have just created. Do not forget to provide your article url (if applicable) through `TeadsAdRequestSettings`. To know more about `TeadsAdRequestSettings` parameters check [this](#teadsadrequestsettings).
94
+
You can then request an ad using the placement you've just created. Do not forget to provide your article url (if applicable) through `TeadsAdRequestSettings`. To know more about `TeadsAdRequestSettings` parameters check [this](#teadsadrequestsettings).
96
95
97
96
```swift
98
97
let adSettings =TeadsAdRequestSettings(build: { (settings) in
@@ -108,7 +107,7 @@ The old `TFAAdDelegate` has been replaced by two new delegates `TeadsInReadAdPla
108
107
109
108
#### Implement the TeadsInReadAdPlacementDelegate
110
109
111
-
The TeadsInReadAdPlacementDelegate has4 methods that you need to implement. This delegate responsability is the ad loading process, for example to tell the app when it received an ad or when the ad server failed to deliver one.
110
+
The TeadsInReadAdPlacementDelegate owns4 methods that you need to implement. This delegate isreacting to the ad loading process, for example to let the app know when an adis received or when the ad server failed to deliver one.
The `TeadsAdOpportunityTrackerView` is a view that you will need to add to your slot view *(e.g. the view where you will display the ad)*.
143
-
This view will be provided during the ad request process and will allow Teads to monitor precisely ad opportunities on [**Teads for Publisher**](https://publishers.teads.tv/).
142
+
This view will be provided during the ad request process and will allow Teads to monitor with precision ad opportunities on [**Teads for Publisher**](https://publishers.teads.tv/).
144
143
145
-
You should add it where the ad will be displayed, even if you don't received an ad from our SDK.
144
+
You should add it where the ad will be displayed, even if you didn't have received an ad from our SDK.
146
145
This view needs to be at the origin of your ad slot `(x:0, y:0)`.
147
146
148
147
Once the `TeadsAdOpportunityTrackerView` is visible, it will be automatically removed by the SDK.
The TeadsAdDelegate has5 methods that you need to implement. It isresponsible for following the lifecycle of an ad, the impression, when the user taps on it when an ad it shows and even when the user closes the ad.
160
+
The TeadsAdDelegate own5 methods that you need to implement. This delegate isreacting to the ad lifecycle(e.g. impressions, clicks, ad close, modal presentation...).
Note: didRecordImpression and didRecordClick are for your analytics if you have some, otherwise it could be empty.
198
+
Note: didRecordImpression and didRecordClick are provided for your analytics if you have some, otherwise it could be empty.
200
199
201
200
You are all set! You can now display Teads ads inside your app. 🎉
202
201
@@ -229,7 +228,7 @@ When you request an ad with the adPlacement you can pass customs settings.
229
228
230
229
## TeadsAdPlacementSettings
231
230
232
-
* `disableCrashMonitoring()`, disallows the SDK to add battery informations to our logs.
233
-
* `disableBatteryMonitoring()`, disallows the SDK to send crash logs to our servers.
234
-
* `disableTeadsAudioSessionManagement()`, if you have custom sound session management you need to disable our audio sessio management and implement the TeadsSoundDelegate.
231
+
* `disableCrashMonitoring()`, disallows the SDK to send crash logs to our servers.
232
+
* `disableBatteryMonitoring()`, disallows the SDK to add battery informations to our logs.
233
+
* `disableTeadsAudioSessionManagement()`, if you have custom sound session management you need to disable our audio session management and implement the TeadsSoundDelegate.
0 commit comments