Incorporate Advertising
The purpose of this document is to provide a guide for a programmer to include Tuidd Integrated Advertising on their site.
The following code must be included:
|
|
Include a container with the following example source code:
|
<div class='tuidd-embedded-advertising' data-slot='457ay33i633992k13m817431v1z38hb2' data-layout='300x250' data-sitekey='18CBB71C-81FB-8B2D-5B64-E399275752AF' data-source='ANY' data-filter='{ "gender":"M", "language":"es", "age_range":[4,5,6], "category":["18"], "exception":["Nike"]}' > </div >
|
|
Field |
Type |
Required |
Description |
|
class |
String |
Required |
'tuidd-embedded-advertising' |
|
data-layout |
String |
Required |
Indicates the size of the ad. The possible values:
|
|
data-source |
String |
Optional |
Restrict the origin of the advertising, to indicate if you want to receive your own advertising only or also from third parties. The possible values are:
If this field is not specified, the default value is ANY . |
|
data-slot |
String |
Required |
It is an identifier of the space destined for advertising. |
|
data-sitekey |
String |
Required |
Site advertising token, obtained from the Tuidd management portal, when the site is registered. |
|
data-filter |
Object |
Optional |
JSON with filters to customize the types of advertising to show.
|
To select the ads to display, tuidd filters the available ads. To do this, tuidd uses the user profile data included in the request (e.g., age, city, etc.) plus the information tuidd stores. This is combined with the filtering (segmentation) settings loaded in each advertisement, which define the target audience it is directed to (e.g., people between 18 and 55 years old, who live in Asunción or Ciudad del Este).
There are three stages: two for filtering and another for selecting advertisements based on relevance.
Phase I is performed using static filters. A static filter is a filter that allows for a quick initial preselection of the set of advertisements to choose from (some of which are, for example, age and gender).
Phase II of filtering uses a filter criterion called "hard and soft filters." This second filtering process is called dynamic filtering and is performed by traversing the data set obtained in Phase I. All Hard filter conditions that do not match cause the ad to be discarded, while soft filters that match assign a score that is computed in Phase III. When a user's data does not match the ad's segmentation, the ad's relevance score is subtracted. (Some soft filters are, for example, language, region, device, etc.)
Phase III At the end of Phase II, each ad in the set has a score that represents the ad's relevance value, based on whether or not the user data matches the ad's segmentation. The ads with the highest score are the most relevant. The selected ad is the most relevant of all. If there is more than one ad with the same relevance value, one is chosen at random.
Filter classification
(E)Static/ Dynamic: (S)Soft/(H)Hard
-
Country (E): Country where the user is located (single value)
-
Language (E): Language of the country or the user if defined
-
Field (S): Identifies the type of advertising, example: Electronics, Retail, etc.
-
Gender (S): Male or Female. If not passed, it doesn't matter
-
Region (H): Region can be a province or district depending on the country (single value)
-
City (H): City where the user is located (single value)
-
Age (S): Value by age range
-
Device (S): Compares the device (Tablet, Cell phone, etc.) through which the user accesses the advertisement.
-
BirthdayMonth (S): Month informed by the user if it exists.
-
Purchasing Power (S): Quantitative value based on the standard purchasing power scale.
-
Exceptions (H): Indicates the brands that will be excluded. This is to prevent competitor ads from appearing on your page.
The fields are:
|
Field |
Type |
Required |
Description |
|
gender |
String |
Optional |
Possible values: "M": Masculine; "F": Feminine;
Default value is "all".
|
|
language |
String |
Optional |
Language codes according to ISO 639-1. Ex: in-bottom: 0in;" align="justify"> "es": Spanish "en": English "pt": Portuguese
|
|
age |
Arrangement |
Optional |
Age ranges, according to the following list:
|
|
category |
Arrangement |
Optional |
IDs of the categories of the ads I want to include. Only supports 3 IDs . After the third one, they will be ignored. See the list of category below.
|
|
purchasing_power |
Integer |
Optional |
User purchasing power. The possible values are:
|
|
location |
Location |
Optional |
User location. It is an element of type Location (defined in this section).
|
|
exception |
Arrangement |
Optional |
List of advertising brands to be excepted. |
List of items for the advertising filter:
|
ID |
Description |
|
1 |
Public Administration |
|
2 |
Agro and Industry |
|
3 |
Animals and Pets |
|
4 |
Art and Culture |
|
5 |
Automobiles and Vehicles |
|
6 |
Beauty and Fitness |
|
7 |
Science and Technology |
|
8 |
Computers and Electronics |
|
9 |
Adult Content |
|
10 |
Sports |
|
11 |
Education and Career |
|
12 |
Entertainment |
|
13 |
Gastronomy |
|
14 |
Home and Garden |
|
15 |
Apparel and Footwear |
|
16 |
Real Estate and Construction |
|
17 |
Internet and Telecommunications |
|
18 |
Business and Finance |
|
19 |
News and Media |
|
20 |
People and Society |
|
21 |
Food products |
|
22 |
Recreation and Hobbies |
|
23 |
Social Network and Blog |
|
24 |
Reference and Documentation |
|
25 |
Health and Social Services |
|
26 |
Shopping and Commerce |
|
27 |
Transportation and Logistics |
|
28 |
Travel and Accommodation |
|
29 |
Video games |
|
64 |
Others |
Represents a way to identify the user's location. It contains various forms of location depending on the available information. If the location is included, at least one of the fields must be present. If both fields have values, the geoloc field will be used.
|
Field |
Type |
Required |
Description |
|
geoloc |
Geoloc |
Optional |
Location by coordinates. It is a Geoloc type element. |
|
georef |
Georef |
Optional |
Location by reference name. It is an element of type Georef |
Location defined as a pair of latitude (lat) - longitude (lon) coordinates in wgs84 (World Geodetic System) format.
|
Field |
Type |
Required |
Description |
|
lat |
String |
Required |
Format (wgs84) Ex: 42.54391 |
|
long |
String |
Required |
Format (wgs84) |
Location through reference to known locations. This can be done by one of these 2 methods:
1- The name of the city in English.
2- The ISO (3166) corresponding to the region.
|
Field |
Type |
Required |
Description |
|
city |
String |
Optional |
Name of the city in English Ex: Beijing |
|
Region |
String |
Optional |
ISO-3166 can be: 1 [Country code] Where: Example: |