Skip to content

Commit f3a3234

Browse files
author
Jose Gomez de Lara
committed
Advertising , promotion and splashscreens help text
1 parent 993d426 commit f3a3234

File tree

7 files changed

+254
-0
lines changed

7 files changed

+254
-0
lines changed

‎console/_images/device.png

1.03 KB
Loading

‎console/game/advertising/config/index.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Advertising Config
2+
On this page you see the configuration for Advertising Network (Admob)
3+
4+
## Content
5+
- [Admob Configuration](#admob-configuration)
6+
7+
## Admob Configuration
8+
9+
- **Platform** Dropdown for selecting the platform to configure
10+
- **Segment Data** Select the segment
11+
- ***Admob***
12+
Configuration for Admob:
13+
- Enable check
14+
- App ID
15+
Configuration per type of Ad
16+
- ***Interstitials***
17+
- ***Videos***
18+
- ***Banners***
19+
20+
- ***Priority Ads*** Priority Ads can be added ,per type of Ad, clicking on **Add Priority Ad** button for the selected type. A form will appear to fill in details for the priority Ad:
21+
- **Name** Priority Ad Name
22+
- **Network** Dropdown for selecting the Ad network
23+
- **Impressions per session** Number of impressions per session for the Ad
24+
- **Date Range** Start and End date and the option to set it to users local time or UTC time
25+
- **Ad unit ID** The Ad unit ID
26+
- **Active** Switch for enabling the Ad

‎console/game/advertising/interstitial/index.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## Interstitial
2+
3+
This page shows the different interstitials created for this game
4+
5+
## Content
6+
- [Table listing](#table-listing)
7+
- [Create Interstitial](#create-interstitial)
8+
- [Edit Interstitial](#edit-interstitial)
9+
- [Remove Interstitial](#remove-interstitial)
10+
11+
## Table Listing
12+
13+
- **Name** Interstitial name
14+
- **Enabled** If it's enabled or not
15+
- **Start Date** Interstitial Start Date
16+
- **End Date** Interstitial End Date
17+
- **Platforms** Interstitial available for the listed platforms
18+
19+
## Create Interstitial
20+
1. Click on **Create interstitial**
21+
2. An Create new interstitial form will appear with the following fields:
22+
- **Name** Name of the new interstitial. This is mandatory
23+
- **Provider** Dropdown for selecting the Ad Network provider
24+
- **Enabled** Check for enabling the interstitial
25+
- **Start Date** Insterstitial Start Date
26+
- **End Date** Insterstitial End Date
27+
- **Priority** Instertitial priority
28+
- **Platforms** Different platforms and version ranges where the interstitial will be included
29+
- **Rule groups** Move the rule groups to the Selected panel for filtering the interstitial by available Rule groups
30+
- **Triggers** Triggers can be added by clicking on **Add Trigger** button and selecting an event from the dropdown and a condition
31+
- **Conditions** Conditions can be added by clicking on **Add Condition** and selecting the different parameters for the condition
32+
3. Click on **Save** to store the changes
33+
34+
On the right side of the screen you can see the insterstitial performance for last week
35+
36+
## Edit Interstitial
37+
1. Click on **Edit interstitial** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button on the selected row
38+
2. An edit interstitial form will appear with the following fields:
39+
- **Name** Name of the new interstitial. This is mandatory
40+
- **Provider** Dropdown for selecting the Ad Network provider
41+
- **Enabled** Check for enabling the interstitial
42+
- **Start Date** Insterstitial Start Date
43+
- **End Date** Insterstitial End Date
44+
- **Priority** Instertitial priority
45+
- **Platforms** Different platforms and version ranges where the interstitial will be included
46+
- **Rule groups** Move the rule groups to the Selected panel for filtering the interstitial by available Rule groups
47+
- **Triggers** Triggers can be added by clicking on **Add Trigger** button and selecting an event from the dropdown and a condition
48+
- **Conditions** Conditions can be added by clicking on **Add Condition** and selecting the different parameters for the condition
49+
3. Click on **Save** to store the changes
50+
51+
On the right side of the screen you can see the insterstitial performance for last week
52+
53+
## Remove Interstitial
54+
1. Click on **Remove Interstitial** ![trash](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/trash.png) button
55+
2. You will be prompted to verify your action
56+
This action will delete the Interstitial.

‎console/game/advertising/statistics/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Statistics
2+
3+
This page shows statistics for the different type of Ads, interstitial, rewarded video and banners

‎console/game/promotion/promotion/index.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Promotions
2+
On this page you see a list of campaign Promotions that are existing.
3+
4+
## Content
5+
- [Table listing](#table-listing)
6+
- [Create promotion](#create-promotion)
7+
- [Edit promotion](#edit-promotion)
8+
9+
## Table listing
10+
11+
- **Id** Promotion id
12+
- **Enabled** If the promotion has been enabled or not
13+
- **Status** The current status of the promotion: finished or running
14+
- **Name** Promotion name
15+
- **StartDate** Promotion start date
16+
- **EndDate** Promotion end date
17+
18+
## Create promotion
19+
20+
To create a new promotion:
21+
22+
1. Click on **Create Promotion**
23+
2. A modal will appear with the create promotion form, the form contains the following fields:
24+
- **Name** Name for the promotion
25+
- **Enabled** If it's going to be enabled
26+
- **Label** Label for the promotion
27+
- **Start Date** Start date for the promotion to be active
28+
- **End Date** End date for the promotion to be not active anymore
29+
- **Send at** Based on UTC or Users Local time
30+
- **Duration** Duration of the Promotion
31+
- **Duration unit** Unit for the duration of the Promotion
32+
- **Max purchases** Maximum amount that this promotion can be purchased
33+
- **Affected entities** The affected entities the promotion is aiming at
34+
- **Price override** Price override for the affected entities
35+
- **Extra entities** Extra entities that can be affected by the promotion
36+
- **Platforms** Platforms and versions where the promotion will be available
37+
- **Segment data** Segments where the promotion will be active
38+
- **Rule groups** Filter the promotion based on groups
39+
- **Conditions** Condition for triggering the promotion
40+
3. Click save to store your changes
41+
42+
## Edit Promotion
43+
44+
To edit a promotion , click the **Edit Promotion** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button. A form will appear with the same fields than **Create promotion**, plus an option for Add Game Integration and an option to Create a Campaign based on the edited promotion.

‎console/game/splashscreen/campaign/index.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Campaign
2+
3+
This page shows the different campaigns created for the game
4+
5+
## Content
6+
- [Table listing](#table-listing)
7+
- [Create campaign](#create-campaign)
8+
- [Edit campaign](#edit-campaign)
9+
- [Testing devices](#testing-devices)
10+
- [Remove campaign](#remove-campaign)
11+
12+
13+
## Table Listing
14+
15+
- **Name** Campaign name
16+
- **Enabled** If it's enabled or not
17+
- **Status** Status of the campaign, finished or running
18+
- **Creative** Creative that it's been used by the campaign
19+
- **Start Date** Campaign Start Date
20+
- **End Date** Campaign End Date
21+
- **Timezone** Localtime or UTC time zones
22+
- **Platforms** Campaign available for the listed platforms
23+
24+
## Create Campaign
25+
1. Click on **Create campaign**
26+
2. An Create new campaign form will appear with the following fields:
27+
- **Name** Name of the new campaign. This is mandatory
28+
- **Enabled** Check for enabling the campaign
29+
- **Creative** The Creative template the campaign will use
30+
- **Start Date** Campaign Start Date
31+
- **End Date** Campaign End Date
32+
-***Check for UTC*** - Note that you can set in the dropdown the send parameter to use user's local time or UTC time
33+
- **Delay** Splashscreen from the campaign will not be shown for this period
34+
- **Delay unit** The time unit for the delay. This can range from second to month
35+
-***Show on game demand*** - Note that you can set in the dropdown if the campaign will be shown immidiately or on game demand
36+
- **Priority** Set the priority whenever multiple splashscreens are triggered at the same time
37+
- **Platforms** Different platforms and version ranges where the campaign will be included
38+
- **Rule groups** Move the rule groups to the Selected panel for filtering the campaign by available Rule groups
39+
- **Triggers** Triggers can be added by clicking on **Add Trigger** button and selecting an event from the dropdown and a condition
40+
- **Entity triggers** Entity triggers can be added by clicking on **Add Entity Trigger** and selecting the type of entity, the selected entity, and the conditions for the trigger
41+
- **Conditions** Conditions can be added by clicking on **Add Condition** and selecting the different parameters for the condition
42+
43+
3. Click on **Save** to store the changes
44+
45+
## Edit Campaign
46+
47+
1. Click on **Edit campaign** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button on the selected row
48+
2. An Edit campaign form with the following fields will appear:
49+
- **Name** Name of the new campaign. This is mandatory
50+
- **Enabled** Check for enabling the campaign
51+
- **Creative** The Creative template the campaign will use
52+
- **Start Date** Campaign Start Date
53+
- **End Date** Campaign End Date
54+
-***Check for UTC*** - Note that you can set in the dropdown the send parameter to use user's local time or UTC time
55+
- **Delay** Splashscreen from the campaign will not be shown for this period
56+
- **Delay unit** The time unit for the delay. This can range from second to month
57+
-***Show on game demand*** - Note that you can set in the dropdown if the campaign will be shown immidiately or on game demand
58+
- **Priority** Set the priority whenever multiple splashscreens are triggered at the same time
59+
- **Platforms** Different platforms and version ranges where the campaign will be included
60+
- **Rule groups** Move the rule groups to the Selected panel for filtering the campaign by available Rule groups
61+
- **Triggers** Triggers can be added by clicking on **Add Trigger** button and selecting an event from the dropdown and a condition
62+
- **Entity triggers** Entity triggers can be added by clicking on **Add Entity Trigger** and selecting the type of entity, the selected entity, and the conditions for the trigger
63+
- **Conditions** Conditions can be added by clicking on **Add Condition** and selecting the different parameters for the condition
64+
65+
On the right side of the screen you can see the Campaign performance for last week
66+
67+
## Testing devices
68+
1. Click on **Testing devices** ![device](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/device.png) button on the selected row
69+
2. A popup will appear. Click on **Add Testing Device**
70+
3. Select device from dropdown and check the desired parameters for testing purposes
71+
4. Repeat operation to add the desired number of testing devices
72+
5. Save to store your changes
73+
74+
## Remove Campaign
75+
1. Click on **Remove campaign** ![trash](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/trash.png) button
76+
2. You will be prompted to verify your action
77+
This action will delete the campaign.

‎console/game/splashscreen/creative/index.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## Creatives
2+
3+
This page shows the different splashscreens
4+
5+
## Content
6+
- [Table listing](#table-listing)
7+
- [Create creative](#create-creative)
8+
- [Edit creative](#edit-creative)
9+
- [Remove creative](#remove-creative)
10+
- [Copy creative](#copy-creative)
11+
12+
## Table listing
13+
14+
- **Id** Splashscreen creative id
15+
- **Name** Creative name
16+
- **Template** Template used for the creative
17+
18+
## Create creative
19+
20+
1. Click on **Create creative**
21+
2. An Create creative modal will appear with the following fields:
22+
- **Name** Name of the new creative
23+
- **Template** Dropdown to select the template for the Creative
24+
3. Click on **Save** to store the changes and optionally select the **Create another** checkbox in order to create another creative
25+
26+
27+
28+
## Edit creative
29+
30+
1. Click on **Edit creative** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button on the selected row
31+
2. An Edit creative form with the following fields will appear:
32+
- **Name** Name of the creative
33+
- **Template** Template used by the creative
34+
**TEMPLATE**
35+
Based on the template chosen, different fields will be available per language. Each tab has a form to be filled based on the languages the creative will be available for each locale
36+
37+
Click on **Preview Locale** to open a new tab to see a preview of your changes on the creative of that particular locale
38+
39+
40+
## Remove creative
41+
1. Click on **Remove creative** ![trash](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/trash.png) button
42+
2. You will be prompted to verify your action or with a reject message detailing the reasons for the rejection.
43+
This action will delete the creative.
44+
45+
46+
47+
## Copy creative
48+
1. Click on **Copy creative** ![duplicate](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/duplicate.png) button

0 commit comments

Comments
 (0)