Поделиться источниками данных

В myTarget существует возможность делиться собственными списками данных и счётчиками Top@Mail.ru с другими пользователями.

Сама процедура происходит следующим образом: владелец источника генерирует специальный ключ, предоставляет его клиенту, а тот активирует ключ, что открывает ему доступ к использованию данного источника.

Методы владельца списка

Запрос генерации ключа:

POST /api/v2/sharing_keys.json

{
"sources": [
     {
       "object_type": "users_list",
       "object_id": 123456,
     },
     ....]
  "users": [ {"username": "lamoda@mail.ru"}, ...],
  "send_email": true/false,
  "price": float,
  "payment_type": "free"|"fixed_cpm",   
  "is_marketplace": true/false
}

  • Object_type:
    • users_list – для списков пользователей;
    • counter – для счётчиков.
  • Object_id – идентификатор источника, которым необходимо поделиться
  • Users – список аккаунтов пользователей myTarget, которым будет доступна активация ключа. Если список пользователей пустой ([]), то ключ будет считаться публичным, т.е. каждый пользователь, который получил ключ, сможет его активировать. В списке могут указываться в том числе любые электронные адреса. Если пользователь с указанным адрессом не зарегистрирован в таргете, то при регистрации ему будет открыт доступ к списку.
  • Send_email – флаг, определяющий, необходимо ли оповещение пользователей о том, что с ними поделились данным источником. Возможность отправки есть только для приватных ключей (когда известен список пользователей\адресов).
  • price - цена в рублях за 1000 показов при платной модели (доступен только для DMP)
  • payment_type - тип ключа по бизнес-модели, оплачиваемая или нет (доступен только для DMP)
  • is_marketplace - флаг определяющий попадание сегментов в маркетплейс (доступен только для DMP). Для публикации в маректплейс, массив users - должен быть пустым ([])

Ответ:

{
  "sharing_key": "absgd124ldsg0900",
  "sharing_url": "https://target.my.com/activate_sharing_key?key=absgd124ldsg0900"
}

Важно! Генерация ключа автоматически не предоставляет право на использование списка клиенту. Пользователю нужно будет обязательно активировать ключ для получения доступа к использованию списка. 

Просмотр источников, которыми поделились:

GET /api/v2/sharing_keys.json

Ответ:

{
  "items": [
    {
      "sources": [ {"object_type": "users_list", "object_id": 123456}, ...],
      "owner": {"id": 431, "username": "user_list_owner_name"},
      "users": [ {"id": 432, "username": "user_list_client_name"}, ... ],
    }
  ]
}

В ответе содержатся все пользователи, вне зависимости от того, активировали ли они ключ или ещё нет.

Можно отозвать предоставление доступа c помощью запроса

DELETE /api/v2/sharing_keys/<key>.json

Методы клиента

Активация ключа:

POST /api/v2/sharing_keys/<key>.json

{"status": "active"}

Клиент может удалить активированный им истоник так же, как и свой собственный. Для списков пользователей:

DELETE /api/v1/remarketing_users_list/{users_list_id}.json

Для счётчиков Top@Mail.ru:

DELETE /api/v1/remarketing_counters/<counter_id>.json