Skip to content

Commit 263d657

Browse files
marchboldmarchbold
committed
fix: add missing adverts mediation docs
1 parent 44e74e0 commit 263d657

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+4987
-0
lines changed

‎docs/adverts/mediation/adcolony/_includes/add-apm-appdescriptor.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
Updating your application descriptor will insert the required `extensionID`'s and generate the manifest and info additions for your application.
4+
5+
You update your application descriptor by running:
6+
7+
```
8+
apm generate app-descriptor src/MyApp-app.xml
9+
```
10+
11+
Change the path (`src/MyApp-app.xml`) to point to your application descriptor.
12+
13+
:::caution
14+
This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from `apm`.
15+
16+
You should backup your application descriptor before running this command to ensure you don't lose any information.
17+
18+
If you need to insert custom data into these sections see the guides for [Android](https://github.com/airsdk/apm/wiki/Usage-Generate#android) and [iOS](https://github.com/airsdk/apm/wiki/Usage-Generate#ios)
19+
:::
20+

‎docs/adverts/mediation/adcolony/_includes/add-apm.mdx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
:::info
3+
Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.
4+
:::
5+
6+
import SetupAPM from '../../../../_includes/apm/setup-apm.mdx'
7+
8+
<SetupAPM />
9+
10+
11+
12+
### Install the extension
13+
14+
Install the extension by running:
15+
16+
```
17+
apm install com.distriqt.admob.AdColony
18+
```
19+
20+
This will download and install the extension, required assets, and all dependencies.
21+
22+
Once complete `apm` will have created something like the following file structure:
23+
24+
```
25+
.
26+
|____ ane
27+
| |____ com.com.distriqt.admob.AdColony.ane # AdColony AdMob mediation extension
28+
| |____ [dependencies]
29+
|____ apm_packages # cache directory - ignore
30+
|____ project.apm # apm project file
31+
```
32+
33+
- Add the `ane` directory to your IDE. *See the tutorials located [here](/docs/tutorials/getting-started) on adding an extension to your IDE.*
34+
35+
:::info
36+
We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using `apm` that these updates will be pulled into your build automatically.
37+
:::
38+
39+

‎docs/adverts/mediation/adcolony/_includes/add-manual-appdescriptor.mdx‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
2+
### Extension IDs
3+
4+
The following should be added to your `extensions` node in your application descriptor to identify all the required ANEs in your application:
5+
6+
```xml
7+
<extensions>
8+
<extensionID>com.distriqt.admob.AdColony</extensionID>
9+
10+
<!-- ADVERTS EXTENSIONS -->
11+
<extensionID>com.distriqt.Adverts</extensionID>
12+
<extensionID>com.distriqt.Core</extensionID>
13+
14+
<extensionID>com.distriqt.playservices.Base</extensionID>
15+
<extensionID>com.distriqt.playservices.Ads</extensionID>
16+
<extensionID>com.distriqt.playservices.AppSet</extensionID>
17+
18+
<extensionID>androidx.appcompat</extensionID>
19+
<extensionID>androidx.browser</extensionID>
20+
<extensionID>androidx.core</extensionID>
21+
<extensionID>androidx.constraintlayout</extensionID>
22+
<extensionID>androidx.vectordrawable</extensionID>
23+
<extensionID>androidx.room</extensionID>
24+
<extensionID>androidx.work</extensionID>
25+
<extensionID>com.google.code.gson</extensionID>
26+
<extensionID>com.jetbrains.kotlin</extensionID>
27+
</extensions>
28+
```
29+
30+
### Android
31+
32+
If there is an `assets` directory alongside the extension in the repository that contains required assets for the installed extensions.
33+
You must add the files in the `assets/android` folder to the root of your Android application package.
34+
35+
36+
#### Manifest Additions
37+
38+
No additions required
39+
40+
41+
### iOS
42+
43+
If there is an `assets` directory alongside the extension in the repository that contains required assets for the installed extensions.
44+
You must add the files in the `assets/ios` folder to the root of your iOS application package.
45+
46+
#### Info Additions
47+
48+
Add the following to your info additions. If you already have an `SKAdNetworkItems` then append the `dict` items to the `array`.
49+
50+
```xml
51+
<key>SKAdNetworkItems</key>
52+
<array>
53+
<dict>
54+
<key>SKAdNetworkIdentifier</key>
55+
<string>4pfyvq9l8r.skadnetwork</string>
56+
</dict>
57+
<dict>
58+
<key>SKAdNetworkIdentifier</key>
59+
<string>6g9af3uyq4.skadnetwork</string>
60+
</dict>
61+
</array>
62+
```
63+
64+
Also check each ad network partner's documentation for any additional `SKAdNetworkIdentifier` values that they require:
65+
66+
- [AdColony](https://support.adcolony.com/helpdesk/network-ids-for-skadnetwork-ios-only/)
67+
68+
:::note SKAdNetworkItems
69+
You should only have one `SKAdNetworkItems` entry. If you have multiple extensions adding these values you must combine them into a single array.
70+
:::

‎docs/adverts/mediation/adcolony/_includes/add-manual.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
:::info
3+
The following guide is used to manually install the extension, download dependencies and update the application descriptor. We highly recommend installing extensions using `apm`. Using `apm` will automate the installation and automatically handle updates and dependencies along with greatly simplifying the application descriptor generation.
4+
:::
5+
6+
7+
The `com.distriqt.admob.AdColony` ANE includes the AdColony SDK and the AdMob AdColony mediation adapter. This is everything you need to get AdColony mediation working in your application.
8+
9+
To add the ANE download it from the repository and add it to your application:
10+
11+
- [`com.distriqt.admob.AdColony`](https://github.com/distriqt/ANE-Adverts-Mediation/raw/master/lib/adcolony/com.distriqt.admob.AdColony.ane)
12+
13+
14+
More information on adding ANEs in this [tutorial](/docs/tutorials/getting-started)
15+

‎docs/adverts/mediation/adcolony/images/adcolony-setup_new_app.png‎

72.7 KB
Loading

‎docs/adverts/mediation/adcolony/images/adcolony-test.png‎

36.7 KB
Loading

‎docs/adverts/mediation/adcolony/index.mdx‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
---
2+
title: AdColony
3+
sidebar_label: AdColony
4+
slug: /adverts/mediation/adcolony
5+
---
6+
7+
import Tabs from '@theme/Tabs'
8+
import TabItem from '@theme/TabItem'
9+
10+
import InstallAPM from './_includes/add-apm.mdx'
11+
import InstallManual from './_includes/add-manual.mdx'
12+
13+
import AppDescriptorAPM from './_includes/add-apm-appdescriptor.mdx'
14+
import AppDescriptorManual from './_includes/add-manual-appdescriptor.mdx'
15+
16+
17+
:::danger Deprecated
18+
AdColony is now deprecated.
19+
20+
With AdColony being deprecated, we recommend removing AdColony from your project.
21+
22+
```
23+
apm uninstall com.distriqt.admob.AdColony
24+
```
25+
26+
This documentation only applies to legacy versions of the extension.
27+
:::
28+
29+
30+
31+
This guide is intended for publishers who want to use the Google Mobile Ads SDK to load and display ads from AdColony through Open Bidding or waterfall mediation. It covers how to add AdColony ads to an ad unit's mediation configuration, and how to integrate the AdColony SDK and adapter into an AIR app.
32+
33+
34+
## Step 1: Set up AdColony
35+
36+
[Sign up](https://clients.adcolony.com/signup) or [log in](https://clients.adcolony.com/login) to your AdColony account. Add your app to the [AdColony publisher dashboard](https://clients.adcolony.com/apps) by clicking the **Setup New App** button.
37+
38+
![](images/adcolony-setup_new_app.png)
39+
40+
Continue following the guide on the AdMob site:
41+
- [Android](https://developers.google.com/admob/android/mediation/adcolony#step_1_set_up_adcolony)
42+
- [iOS](https://developers.google.com/admob/ios/mediation/adcolony#step_1_set_up_adcolony)
43+
44+
45+
46+
## Step 2: Configure mediation settings for your AdMob ad unit
47+
48+
- [Android](https://developers.google.com/admob/android/mediation/adcolony#step_2_configure_mediation_settings_for_your_ad_unit)
49+
- [iOS](https://developers.google.com/admob/ios/mediation/adcolony#step_2_configure_mediation_settings_for_your_ad_unit)
50+
51+
52+
53+
## Step 3: Import the AdColony SDK and adapter ANE
54+
55+
The simplest way to install and manage your AIR native extensions and libraries is to use the AIR Package Manager (`apm`). We highly recommend using `apm`, as it will handle downloading all required dependencies and manage your application descriptor (Android manifest additions, iOS info additions etc).
56+
57+
However you can choose to install it manually, as you would have done in the past.
58+
59+
### Add the Extension
60+
61+
<Tabs
62+
groupId="packagemanager"
63+
defaultValue="apm"
64+
values={[
65+
{label: 'APM', value: 'apm'},
66+
{label: 'Manual', value: 'manual'},
67+
]}>
68+
69+
<TabItem value="apm" >
70+
<InstallAPM/>
71+
</TabItem>
72+
<TabItem value="manual" >
73+
<InstallManual/>
74+
</TabItem>
75+
76+
</Tabs>
77+
78+
79+
### Application Descriptor
80+
81+
<Tabs
82+
groupId="packagemanager"
83+
defaultValue="apm"
84+
values={[
85+
{label: 'APM', value: 'apm'},
86+
{label: 'Manual', value: 'manual'},
87+
]}>
88+
89+
<TabItem value="apm" >
90+
<AppDescriptorAPM/>
91+
</TabItem>
92+
<TabItem value="manual" >
93+
<AppDescriptorManual/>
94+
</TabItem>
95+
96+
</Tabs>
97+
98+
99+
100+
## Step 4: Additional code required
101+
102+
No additional code required
103+
104+
105+
## Step 5: Test your implementation
106+
107+
To enable test ads on AdColony, go to your AdColony dashboard and navigate to Monetization > Apps. Select your Zone for which you would like to enable test ads under the Ad Zones section of your app. Test ads can be enabled by checking Yes to Show test ads only? under the Development section.
108+
109+
![](images/adcolony-test.png)
110+
111+
112+
113+
## Optional steps
114+
115+
### EU Consent and GDPR
116+
117+
118+
Under the Google EU User Consent Policy, you must ensure that certain disclosures are given to, and consents obtained from, users in the European Economic Area (EEA) regarding the use of device identifiers and personal data. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR). When seeking consent, you must identify each ad network in your mediation chain that may collect, receive, or use personal data and provide information about each network's use. Google currently is unable to pass the user's consent choice to such networks automatically.
119+
120+
The section below shows you how to enable or disable personalized ads for AdColony.
121+
122+
123+
124+
125+
The AdColony adapter provides the `AdColony.instance.getAppOptions()` method to customize parameters to be sent to AdColony's SDK. Two methods relevant to GDPR on these options are `setPrivacyFrameworkRequired()` and `setPrivacyConsentString()`, added in AdColony SDK 4.2.0. The following sample code demonstrates how to pass these parameters to the AdColony adapter, which are then used in AdColony’s initialization method. These options must be set before you initialize mobile ads to ensure they get forwarded properly to AdColony's SDK:
126+
127+
128+
```actionscript
129+
AdColony.instance.getAppOptions()
130+
.setPrivacyFrameworkRequired( AdColonyAppOptions.GDPR, true )
131+
.setPrivacyConsentString( AdColonyAppOptions.GDPR, "1" );
132+
```
133+
134+
See [AdColony’s GDPR implementation details](https://github.com/AdColony/AdColony-Android-SDK/wiki/Privacy-Laws#gdpr) for more information about what values may be provided in these methods.
135+
136+
137+
138+
139+
### Permissions
140+
141+
For optimal performance, AdColony recommends adding the following optional permissions to your app's manifest additions:
142+
143+
```xml
144+
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
145+
<uses-permission android:name="android.permission.VIBRATE" />
146+
```
147+
148+
## Further information
149+
150+
See the Google AdColony Mediation guide:
151+
152+
https://developers.google.com/admob/android/mediation/adcolony
153+
154+

‎docs/adverts/mediation/applovin/_includes/add-apm-appdescriptor.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
3+
Updating your application descriptor will insert the required `extensionID`'s and generate the manifest and info additions for your application.
4+
5+
You update your application descriptor by running:
6+
7+
```
8+
apm generate app-descriptor src/MyApp-app.xml
9+
```
10+
11+
Change the path (`src/MyApp-app.xml`) to point to your application descriptor.
12+
13+
:::caution
14+
This will modify your application descriptor replacing the manifest additions and info additions with the ones generated from `apm`.
15+
16+
You should backup your application descriptor before running this command to ensure you don't lose any information.
17+
18+
If you need to insert custom data into these sections see the guides for [Android](https://github.com/airsdk/apm/wiki/Usage-Generate#android) and [iOS](https://github.com/airsdk/apm/wiki/Usage-Generate#ios)
19+
:::
20+

‎docs/adverts/mediation/applovin/_includes/add-apm.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
:::info
3+
Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory.
4+
:::
5+
6+
import SetupAPM from '../../../../_includes/apm/setup-apm.mdx'
7+
8+
<SetupAPM />
9+
10+
11+
### Install the extension
12+
13+
Install the extension by running:
14+
15+
```
16+
apm install com.distriqt.admob.AppLovin
17+
```
18+
19+
This will download and install the extension, required assets, and all dependencies.
20+
21+
Once complete `apm` will have created something like the following file structure:
22+
23+
```
24+
.
25+
|____ assets
26+
| |____ ios
27+
| | |____ Frameworks
28+
| | | |____ [dynamic frameworks]
29+
|____ ane
30+
| |____ com.distriqt.admob.AppLovin.ane # AppLovin AdMob mediation extension
31+
| |____ [dependencies]
32+
|____ apm_packages # cache directory - ignore
33+
|____ project.apm # apm project file
34+
```
35+
36+
- Add the `ane` directory to your IDE. *See the tutorials located [here](/docs/tutorials/getting-started) on adding an extension to your IDE.*
37+
38+
- You will have an assets directory that contains required assets for the installed extensions.
39+
You must add the contents of the `assets/ios` folder to the root of your iOS application package.
40+
(The `ios` folder contains a `Frameworks` folder with the required iOS dynamic frameworks).
41+
42+
:::info
43+
We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using `apm` that these updates will be pulled into your build automatically.
44+
:::
45+
46+
47+
48+
49+

0 commit comments

Comments
 (0)