Skip to content

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
enclaved committed Jan 9, 2023
1 parent 7f21d03 commit 5c2b9f5
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 51 deletions.
82 changes: 33 additions & 49 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ $authKey = base64_encode($apiKey . ':');

### Операционные системы

Названия операционных систем (не чувствительны к регистру):
Названия операционных систем не чувствительны к регистру.

```
GET /collections/os
```

* `Android 1`
* `Android 2`
Expand Down Expand Up @@ -80,16 +84,14 @@ $authKey = base64_encode($apiKey . ':');
* `Windows 10`
* `Windows Other`

Получение списка названий операционных систем:
### Браузеры

Названия браузеров не чувствительны к регистру.

```
GET /collections/os
GET /collections/browsers
```

### Браузеры

Названия браузеров (не чувствительны к регистру):

* `Apple Safari`
* `Facebook app`
* `Google Chrome`
Expand All @@ -104,16 +106,14 @@ GET /collections/os
* `WebView`
* `Yandex Browser`

Получение списка названий браузеров:
### Движки браузера

Названия движков браузера не чувствительны к регистру.

```
GET /collections/browsers
GET /collections/engines
```

### Движки браузера

Названия движков браузера (не чувствительны к регистру):

* `Blink`
* `EdgeHTML`
* `Gecko`
Expand All @@ -122,55 +122,45 @@ GET /collections/browsers
* `Trident`
* `WebKit`

Получение списка названий движков браузера:

```
GET /collections/engines
```

### Коды стран

Получение списка кодов стран:

```
GET /collections/countries
```

### Коды языков

Получение списка кодов языков:

```
GET /collections/languages
```

### Часовые пояса

Получение списока часовых поясов:

```
GET /collections/time-zones
```

### Режимы потока

Названия режимов потока (не чувствительны к регистру):
Названия режимов потока не чувствительны к регистру.

```
GET /collections/stream-modes
```

* `Filter` --- фильтр;
* `Review` --- модерация;
* `Money` --- контент;
* `White` --- белая страница.

Получение списка режимов потока:
### Группировки воронки продаж

Группировки воронки продаж не чувствительны к регистру.

```
GET /collections/stream-modes
GET /collections/query-group-by
```

### Группировки воронки продаж

Доступные группировки воронки продаж (не чувствительны к регистру):

* `date` --- по дате;
* `stream_id` --- по потоку;
* `asn` --- по ASN (номеру автономной системы);
Expand All @@ -183,12 +173,6 @@ GET /collections/stream-modes
* `target` --- по показанной странице;
* `tag` --- по тегу.

Получение списка группировок:

```
GET /collections/query-group-by
```

## Управление потоками

Поток представляется в виде объекта со следующими свойствами:
Expand Down Expand Up @@ -258,7 +242,7 @@ GET /collections/query-group-by
"name": "Example Stream",
"tags": ["Tag1", "Tag2"],
"mode": "Filter",
"notes": "This is just an example.",
"notes": "This is an example comment.",
"money_pages": [
{
"page": "https://example.com/offer1?clid={clickid}",
Expand Down Expand Up @@ -290,7 +274,7 @@ GET /collections/query-group-by
"enable_fp": true,
"paranoid": false,
"allow_apps": true,
"countries": ["CA", "US"],
"countries": ["AE", "HK"],
"os": ["iOS", "macOS"],
"browsers": ["Google Chrome"],
"engines": ["Blink"],
Expand Down Expand Up @@ -386,7 +370,7 @@ DELETE /streams/<id>

Эта точка вызова удаляет поток `<id>`.

## Файлы интеграции
## PHP-файлы интеграции

Вы можете скачать файлы `index.php`, `filter.php` и `ajax.php` для любого потока при помощи запросов:

Expand All @@ -406,28 +390,30 @@ DELETE /streams/<id>
указав ID сохраненного запроса в соответствующем поле, либо перейдя по ссылке вида
`https://clients.adspect.ai/reporting?query_id=<id>`, где вместо `<id>` подставляется ID сохраненного запроса.

**Можно создавать не более 100 сохраненных запросов.**

Сохраненный запрос представляется в виде объекта со следующими свойствами:

* `query_id` --- ID сохраненного запроса, только для чтения;
* `owner_id` --- ID аккаунта владельца, только для чтения;
* `date_from` --- минимальное Unix-время, начиная с которого выгружается отчет;
* `date_to` --- максимальное Unix-время, до которого выгружается отчет;
* `time_zone` --- часовой пояс по умолчанию, используемый для отображения даты и времени;
* `group_by` --- группировка воронки продаж по умолчанию;
* `time_zone` --- часовой пояс по умолчанию, используемый для отображения даты и времени, строка;
* `group_by` --- группировка воронки продаж по умолчанию, массив строк;
* `account_id` --- фильтр по ID аккаунтов, массив строк, только для чтения;
* `stream_id` --- фильтр по ID потоков, массив строк;
* `ip_address` --- фильтр по IP-адресам, массив строк;
* `asn` --- фильтр по ASN, массив целых чисел, либо строк вида "AS65536" или "AS1.10";
* `asn` --- фильтр по ASN, массив целых чисел, либо строк вида `AS65536` или `AS1.10`;
* `country_code` --- фильтр по странам, массив строк;
* `os` --- фильтр по операционным системам, массив строк;
* `browser` --- фильтр по браузерам, массив строк;
* `engine` --- фильтр по движкам, массив строк;
* `sub_id` --- фильтр по субаккаунтам, массив строк;
* `click_id` --- фильтр по ID переходов, массив строк;
* `mode` --- фильтр по режиму потока, массив строк из списка: `Filter`, `Review`, `Money`, `White`;
* `target` --- фильтр по показанной странице, массив целых чисел:
* `mode` --- фильтр по режимам потока, массив строк;
* `target` --- фильтр по показанным страницам, массив целых чисел:
* 0 --- белая страница;
* 1 и выше --- контент-страница с соответствующим номером.
* 1--255 --- контент-страница с соответствующим номером.

Все поля необязательны. Если тот или иной фильтр не требуется, то его можно не указывать, либо задать
значение `null` (или пустой массив `[]` там, где ожидается массив).
Expand Down Expand Up @@ -457,8 +443,6 @@ DELETE /streams/<id>
}
```

Можно создавать не более 100 сохраненных запросов.

### Список запросов

```
Expand Down
4 changes: 3 additions & 1 deletion recommendations.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
**Европейский закон о Cookie также требует**, чтобы сайты явно запрашивали разрешение на использование cookies.

8. **Добавляйте файлы** `robots.txt` и `sitemap.xml` в корневую директорию вашего домена, особенно при работе
с рекламой в поисковиках (Google Ads, Microsoft Advertising, Verizon Media Native и т.п.)
с рекламой в поисковиках (Google Ads, Microsoft Advertising, Яндекс, Yahoo Native и т.п.)

9. **Не используйте** скопированные лендинги без изменений, всегда уникализируйте их так или иначе.
Это поможет обойти потенциальные блокировки по сигнатурам страниц.
Expand Down Expand Up @@ -115,6 +115,8 @@
типа интеграции) после банов --- при каждом скачивании файла генерируется новый уникальный код для сбора
JavaScript-отпечатков, что позволяет избежать проблем с "запоминанием" предыдущего кода как вредоносного.

17. **Всегда** добавляйте к ссылке все доступные макросы (`__CAMPAIGN_NAME__` и т.п.) кампаниях TikTok Ads.

## Не выделяйтесь!

Большинство рекламных сетей практикует рутинную перепроверку всех рекламных кампаний время от времени.
Expand Down
2 changes: 1 addition & 1 deletion reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
* `sequence` --- этап обработки перехода;
* `target` --- страница, показанная посетителю:
* 0 --- белая страница;
* 1 и выше --- контент-страница с соответствующим порядковым номером;
* 1--255 --- контент-страница с соответствующим порядковым номером;
* `tags` --- список мнемонических тегов, обозначающих конкретные фильтры или иные причины для блокировки перехода (см. ниже).

### Теги
Expand Down

0 comments on commit 5c2b9f5

Please sign in to comment.