Протокол¶
Оглавление¶
-
keyapis/ad/v1/keyapis_ad_salepoint_v1.proto
- GetSalepointCountResponse
- GetSalepointListRequest
- GetSalepointListResponse
- GetSalepointRequest
- GetSalepointResponse
- PostSalepointRequest
- PostSalepointResponse
- Salepoint
- Salepoint.Location
- Salepoint.Worktime
- SalepointFilter
- SalepointFilter.Location
- Salepoint.Worktime.DayType
- SalepointPaging.DirectionType
- SalepointPaging.OrderByType
Схема классов¶
keyapis/ad/v1/keyapis_ad_salepoint_v1.proto¶
Сервис реализует функционал управления точками продаж. Точки проджаж используются как точки дистрибьюции ключей
SalepointService¶
Сервис точек продаж
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| PostSalepoint | Метод сохранения точки продаж. Поддерживает создание и обновление. Метод доступен для: manager, service, application(ad:edit) | keyapis.ad.v1.PostSalepointRequest | keyapis.ad.v1.PostSalepointResponse |
| GetSalepoint | Метод получения точки продаж. Не требует авторизации | keyapis.ad.v1.GetSalepointRequest | keyapis.ad.v1.GetSalepointResponse |
| GetSalepointList | Метод получения списка точек продаж. Не требует авторизации | keyapis.ad.v1.GetSalepointListRequest | keyapis.ad.v1.GetSalepointListResponse stream |
| GetSalepointCount | Метод получения количества точек продаж. Не требует авторизации | keyapis.ad.v1.GetSalepointCountRequest | keyapis.ad.v1.GetSalepointCountResponse |
GetSalepointCountRequest¶
Запрос получения количества точек продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.ad.v1.SalepointFilter |
GetSalepointCountResponse¶
Ответ на запрос получения количества точек продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего точек продаж | optional int32 |
GetSalepointListRequest¶
Запрос получения списка точек продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.ad.v1.SalepointFilter | |
| paging | Пагинация | optional keyapis.ad.v1.SalepointPaging |
GetSalepointListResponse¶
Ответ на запрос получения списка точек продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Точка продаж | optional keyapis.ad.v1.Salepoint |
GetSalepointRequest¶
Запрос получения точки продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор точки продаж | int32 | REQUIRED |
GetSalepointResponse¶
Ответ на запрос получения точки продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Точка продаж | optional keyapis.ad.v1.Salepoint |
PostSalepointRequest¶
Запрос сохранения точки продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Точка продаж | keyapis.ad.v1.Salepoint | REQUIRED |
PostSalepointResponse¶
Ответ на запрос сохранения точки продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Точка продаж | optional keyapis.ad.v1.Salepoint |
Salepoint¶
Точка продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | |
| title | Название | string | REQUIRED |
| type | Тип точки продаж | keyapis.ad.v1.Salepoint.Type | REQUIRED |
| description | Описание | google.protobuf.StringValue | |
| address | Адрес | string | REQUIRED |
| location | Местонахождение | keyapis.ad.v1.Salepoint.Location | REQUIRED |
| worktimes | Рабочее время | repeated keyapis.ad.v1.Salepoint.Worktime | REQUIRED |
| phone_number | Номер телефона | google.protobuf.StringValue | |
| site_url | Ссылка на сайт | string | REQUIRED |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта | google.protobuf.Timestamp | OUTPUT_ONLY |
| archieved_at | Дата архивации | google.protobuf.Timestamp |
Salepoint.Location¶
Местонахождение
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| latitude | Широта | float | REQUIRED |
| longitude | Долгота | float | REQUIRED |
Salepoint.Worktime¶
Рабочее время
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| day_type | День недели | keyapis.ad.v1.Salepoint.Worktime.DayType | REQUIRED |
| opened_at | Время открытия | string | REQUIRED |
| closed_at | Время закрытия | string | REQUIRED |
SalepointFilter¶
Фильтр точек продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| text | По тексту. Если значение не передано то поиск по нему не производится. # Поиск производится по полям: # - Название | google.protobuf.StringValue | |
| location | По местонахождению. Игнорируется если дистанция не передана | keyapis.ad.v1.SalepointFilter.Location | |
| distance | По дистанции. Игнорируется если местонахождение не передано | google.protobuf.FloatValue | |
| is_archieved | По архивированым | google.protobuf.BoolValue |
SalepointFilter.Location¶
Местонахождение
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| latitude | По широте | float | |
| longitude | По долготе | float |
SalepointPaging¶
Пагинация по точекам продаж
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: ORDER_BY_TYPE_ID | keyapis.ad.v1.SalepointPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.ad.v1.SalepointPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
Salepoint.Type¶
Справочник типов точек продаж
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | TELE2 | Теле2 |
| 2 | POCHTA_ROSSII | Почта россии |
| 3 | PEREKRESTOK | Перекресток |
| 4 | PYATEROCHKA | Пятерочка |
| 5 | ANOTHER | Другая |
| 6 | MEGAFON | Мегафон |
Salepoint.Worktime.DayType¶
Справочник дней
| Номер | Тип | Название |
|---|---|---|
| 0 | DAY_TYPE_UNKNOWN | Значение не указано |
| 1 | MONDAY | Понедельник |
| 2 | TUESDAY | Вторник |
| 3 | WEDNESDAY | Среда |
| 4 | THURSDAY | Четверг |
| 5 | FRIDAY | Пятница |
| 6 | SATURDAY | Суббота |
| 7 | SUNDAY | Воскресенье |
SalepointPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
SalepointPaging.OrderByType¶
Справочник типов значений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По идентификатору |
| 2 | DISTANCE | По дистанции |
| 3 | RANK_CD | По рангу близости. При поиске по тексту |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| uint32 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| sfixed32 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |