Profile data object
Используется в API запросах, связанных с импортом подписчиков в базы данных. В объекте передаются значения полей базы и подписки.
Информацию о всех полях конретной базы данных можно получить по запросу к api/v1.1/databases/fields_get/
.
Общая информация о базах данных и используемых полях доступна в пользовательской документации.
JSON
- JSON
- XML
{
"data": {
"_regcountry": "US",
"_regcity": "New York",
"_regip": "94.231.119.122",
"_regurl": "www.example.com",
"_regdate": "2019-03-14T22:00:00Z",
"_bdate": "1990-02-22T21:00:00Z",
"_browser": "Thunderbird",
"_city": "Ryazan",
"_country": "RU",
"_fname": "Olly",
"_ip": "94.231.119.122",
"_lname": "Lambert",
"_postal_code": "390000",
"_region": "Ryazan Oblast",
"_vendor": "form_#31",
"_sex": 0,
"_status": 0,
"_tz": "Europe/Moscow",
"email": "example@altcraft.com",
"phones": [
"+79000000000"
],
"custom_field": "custom_value",
"subscriptions": [
{
"channel": "email",
"email": "boris.yudaev@altcraft.com",
"priority": 0,
"resource_id": 1,
"status": 0
}
]
}
}
<xml>
<data>
<regcountry>US</regcountry>
<regcity>New York</regcity>
<regip>94.231.119.122</regip>
<regurl>www.example.com</regurl>
<regdate>2019-03-14T22:00:00Z</regdate>
<bdate>1990-02-22T21:00:00Z</bdate>
<browser>Thunderbird</browser>
<city>Ryazan</city>
<country>RU</country>
<fname>Olly</fname>
<ip>94.231.119.122</ip>
<lname>Lambert</lname>
<postal_code>390000</postal_code>
<region>Ryazan Oblast</region>
<vendor>form_#31</vendor>
<sex>0</sex>
<status>0</status>
<tz>Europe/Moscow</tz>
<email>example@altcraft.com</email>
<phones array='true'>+79000000000</phones>
<custom_field>custom_value</custom_field>
<subscriptions array='true'>
<channel>email</channel>
<email>boris.yudaev@altcraft.com</email>
<priority>0</priority>
<resource_id>1</resource_id>
<status>0</status>
</subscriptions>
</data>
</xml>
Описание
Параметр | Тип | Пример | Описание |
---|---|---|---|
bdate | string | 1990-02-22T21:00:00Z | Дата рождения в формате RFC 3339 |
browser | string | Firefox | Браузер |
_city | string | Ryazan | Город |
_country | string | RU | Страна в формате TLD |
_fname | string | Olly | Имя |
_ip | string | 94.231.119.122 | IP адрес * |
_lname | string | Lambert | Фамилия |
_postal_code | int | 390000 | Почтовый индекс |
_region | string | Ryazan Oblast | Регион |
_status | int | 0 | Глобальный статус подписки |
_tz | string | Europe/Moscow | Часовой пояс |
email | string | example@altcraft.com | Адрес электронной почты |
phones | JSON array | ["+79000000000"] | Номера телефонов |
subscriptions | JSON array | ["",""] | Подписки профиля |
custom_field | * | custom_value | Дополнительные поля базы данных. Возможно функциональное обновление полей. Для этого необходимо указать действие ( action ) и значение (value ).Пример запроса для увеличения значения поля: "custom_field": { |
_regcountry | string | US | Страна регистрации в формате TLD |
_regcity | string | New York | Город регистрации |
_regip | string | 94.231.119.122 | IP регистрации |
_regurl | string | www.example.org | URL регистрации |
_regdate | string | 2018-02-22T21:00:00Z | Дата регистрации в формате RFC 3339 |
_sex | int | 0 | Идентификатор Пола, указывается согласно Список гендерных идентификаций |
_vendor | string | form#33 | Форма сбора данных клиентов |
* При передаче в запросе на импорт IP адреса в формате IPv4 платформа автоматически определяет местоположение подписчика и записывает следующие системные поля данных:
- JSON
- XML
{
"_ip": "94.231.119.122", // уже добавляется само по себе
"_lat": 54.6197, // географическая широта
"_lon": 39.74, // географическая долгота
"_postal_code": "390000",
"_region": "Ryazanskaya Oblast",
"_country": "RU",
"_city": "Ryazan",
"_tz": "Europe/Moscow"
}
<xml>
<ip>94.231.119.122</ip>// уже добавляется само по себе
<lat>54.6197</lat>// географическая широта
<lon>39.74</lon>// географическая долгота
<postal_code>390000</postal_code>
<region>Ryazanskaya Oblast</region>
<country>RU</country>
<city>Ryazan</city>
<tz>Europe/Moscow</tz>
</xml>