Предоставление прав на списки пользователей

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

Генерация ключа

Для генерации ключа необходимо отправить запрос

POST /api/v2/sharing_keys.json

со следующим содержимым:

{
"sources": [
     {
       "object_type": "users_list",
       "object_id": 123456,
     },
     ....],
  "users": [ {"username": "lamoda@mail.ru"}, ...],
  "send_email": true/false
}

  • Object_type – для списков данных указывать значение «users_list» - на текущий момент поддерживаются только списки пользователей.
  • Object_id – идентификатор списка, доступ к которому необходимо предоставить.
  • Users – список пользователей, которым будет доступна активация ключа. Если список пользователей пустой ([]), то ключ будет считаться публичным, т.е. каждый пользователь, который получил ключ, сможет его активировать. В списке могут указываться в том числе электронные адреса, для которых нет учётной записи в myTarget. Таким пользователям список будет автоматически открыт сразу после их регистрации в системе.
  • Send_email – флаг, определяющий, необходимо ли оповещение пользователей о том, что с ними поделились данным списком. Возможность отправки есть только для приватных ключей (когда известен список пользователей\адресов).

Шаблон ответа:

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

Sharing_key и есть ключ, с помощью которого можно активировать доступ к списку, а sharing_url позволит пользователям сделать эту активацию в один клик.

 

Управление предоставлением доступа

Получить список всех источников данных, которые предоставлены сторонним пользователям можно с помощью запроса без параметров

GET /api/v2/sharing_keys/sent.json

Шаблон ответа:

{
  "items": [
    {
      "object_type": "users_list",
      "object_id": 123456,
      "owner": {"id": 431, "username": "lamoda@lamoda.com"},
      "users": [ {"id": 432, "username": "lamoda@mail.ru"}, ... ],
    }
  ]
}

Список items содержит все списки, для которых был сгенерирован ключ доступа. В списке users для каждого item будет содержаться информация как об активировавших доступ пользователях (в том числе в случае публичного ключа), так и о пользователях, для которых право на активацию есть, но активация ещё не производилась (только для приватных ключей).

Для удаления возможности использовать список от имени владельца списка, необходимо выполнить запрос вида

DELETE /api/v2/remarketing/users_lists/{user_list_id}/users/{user_id}.json

При удалении доступа к списку, все кампании, в таргетинге которых использовался список, будут автоматически остановлены.

 

Активация доступа к списку

Для активации доступа к списку необходимо отправить

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

{"status": "active"}