Протокол¶
Оглавление¶
Схема классов¶
keyapis/ad/v1/keyapis_ad_marketplace_v1.proto¶
Сервис реализует функционал управления маркетплейсами. Маркетплейсы используются как точки дистрибьюции ключей
MarketplaceService¶
Сервис управления маркетплейсами
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| PostMarketplace | Метод сохранения маркетплейса. Поддерживает создание и обновление. Метод доступен для: manager, service, application(ad:edit) | keyapis.ad.v1.PostMarketplaceRequest | keyapis.ad.v1.PostMarketplaceResponse |
| GetMarketplace | Метод получения маркетплейса. Не требует авторизации | keyapis.ad.v1.GetMarketplaceRequest | keyapis.ad.v1.GetMarketplaceResponse |
| GetMarketplaceList | Метод получения списка маркетплейсов. Не требует авторизации | keyapis.ad.v1.GetMarketplaceListRequest | keyapis.ad.v1.GetMarketplaceListResponse stream |
| GetMarketplaceCount | Метод получения количества маркетплейсов. Не требует авторизации | keyapis.ad.v1.GetMarketplaceCountRequest | keyapis.ad.v1.GetMarketplaceCountResponse |
GetMarketplaceCountRequest¶
Запрос получения количества маркетплейсов
GetMarketplaceCountResponse¶
Ответ на запрос получения количества маркетплейсов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего маркетплейсов | optional int32 |
GetMarketplaceListRequest¶
Запрос получения списка маркетплейсов
GetMarketplaceListResponse¶
Ответ на запрос получения списка маркетплейсов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Маркетплейс | optional keyapis.ad.v1.Marketplace |
GetMarketplaceRequest¶
Запрос получения маркетплейса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор маркетплейса | int32 | REQUIRED |
GetMarketplaceResponse¶
Ответ на запрос получения маркетплейса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Маркетплейс | optional keyapis.ad.v1.Marketplace |
Marketplace¶
Маркетплейс
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | OUTPUT_ONLY |
| title | Название | string | REQUIRED |
| type | Тип маркетплейса | keyapis.ad.v1.Marketplace.Type | REQUIRED |
| is_disabled | Выключен ли маркетплейс | bool | |
| card_url | Ссылка на карточку товара ключа в маркетплейсе | google.protobuf.StringValue | |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта | google.protobuf.Timestamp | OUTPUT_ONLY |
PostMarketplaceRequest¶
Запрос сохранения маркетплейса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Маркетплейс | keyapis.ad.v1.Marketplace | REQUIRED |
PostMarketplaceResponse¶
Ответ на запрос сохранения маркетплейса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Маркетплейс | optional keyapis.ad.v1.Marketplace |
Marketplace.Type¶
Справочник типов маркетплейсов
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | OZON | Озон |
| 2 | WILDBERRIES | Вайлдберриз |
| 3 | YANDEX_MARKET | Яндекс маркет |
| 4 | SBER_MARKET | Яндекс маркет |
Скалярные типы значений¶
| .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 |