# Протокол

## Оглавление

- [keyapis/ad/v1/keyapis_ad_marketplace_v1.proto](#keyapis_ad_v1_keyapis_ad_marketplace_v1-proto)
    - [MarketplaceService](#keyapis-ad-v1-MarketplaceService)
  
    - [GetMarketplaceCountRequest](#keyapis-ad-v1-GetMarketplaceCountRequest)
    - [GetMarketplaceCountResponse](#keyapis-ad-v1-GetMarketplaceCountResponse)
    - [GetMarketplaceListRequest](#keyapis-ad-v1-GetMarketplaceListRequest)
    - [GetMarketplaceListResponse](#keyapis-ad-v1-GetMarketplaceListResponse)
    - [GetMarketplaceRequest](#keyapis-ad-v1-GetMarketplaceRequest)
    - [GetMarketplaceResponse](#keyapis-ad-v1-GetMarketplaceResponse)
    - [Marketplace](#keyapis-ad-v1-Marketplace)
    - [PostMarketplaceRequest](#keyapis-ad-v1-PostMarketplaceRequest)
    - [PostMarketplaceResponse](#keyapis-ad-v1-PostMarketplaceResponse)
  
    - [Marketplace.Type](#keyapis-ad-v1-Marketplace-Type)
  


## [Схема классов](/svg/protos/key/keyapis/ad/v1/keyapis_ad_marketplace_v1.proto.svg)
<a href="/svg/protos/key/keyapis/ad/v1/keyapis_ad_marketplace_v1.proto.svg"><img src="/svg/protos/key/keyapis/ad/v1/keyapis_ad_marketplace_v1.proto.svg" alt="/svg/protos/key/keyapis/ad/v1/keyapis_ad_marketplace_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_ad_v1_keyapis_ad_marketplace_v1-proto"></a>

## [keyapis/ad/v1/keyapis_ad_marketplace_v1.proto](/protos/key/keyapis/ad/v1/keyapis_ad_marketplace_v1.proto)
Сервис реализует функционал управления маркетплейсами.
Маркетплейсы используются как точки дистрибьюции ключей


<a name="keyapis-ad-v1-MarketplaceService"></a>

### MarketplaceService
 Сервис управления маркетплейсами

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-ad-v1-PostMarketplace"></a> [PostMarketplace](#keyapis-ad-v1-PostMarketplace) | Метод сохранения маркетплейса. Поддерживает создание и обновление. Метод доступен для: manager, service, application(ad:edit) | [keyapis.ad.v1.PostMarketplaceRequest](#keyapis-ad-v1-PostMarketplaceRequest) | [keyapis.ad.v1.PostMarketplaceResponse](#keyapis-ad-v1-PostMarketplaceResponse) |
| <a id="keyapis-ad-v1-GetMarketplace"></a> [GetMarketplace](#keyapis-ad-v1-GetMarketplace) | Метод получения маркетплейса. Не требует авторизации | [keyapis.ad.v1.GetMarketplaceRequest](#keyapis-ad-v1-GetMarketplaceRequest) | [keyapis.ad.v1.GetMarketplaceResponse](#keyapis-ad-v1-GetMarketplaceResponse) |
| <a id="keyapis-ad-v1-GetMarketplaceList"></a> [GetMarketplaceList](#keyapis-ad-v1-GetMarketplaceList) | Метод получения списка маркетплейсов. Не требует авторизации | [keyapis.ad.v1.GetMarketplaceListRequest](#keyapis-ad-v1-GetMarketplaceListRequest) | [keyapis.ad.v1.GetMarketplaceListResponse](#keyapis-ad-v1-GetMarketplaceListResponse) stream |
| <a id="keyapis-ad-v1-GetMarketplaceCount"></a> [GetMarketplaceCount](#keyapis-ad-v1-GetMarketplaceCount) | Метод получения количества маркетплейсов. Не требует авторизации | [keyapis.ad.v1.GetMarketplaceCountRequest](#keyapis-ad-v1-GetMarketplaceCountRequest) | [keyapis.ad.v1.GetMarketplaceCountResponse](#keyapis-ad-v1-GetMarketplaceCountResponse) |

 <!-- end services -->


<a name="keyapis-ad-v1-GetMarketplaceCountRequest"></a>


### [GetMarketplaceCountRequest](#keyapis-ad-v1-GetMarketplaceCountRequest)
 Запрос получения количества маркетплейсов






<a name="keyapis-ad-v1-GetMarketplaceCountResponse"></a>


### [GetMarketplaceCountResponse](#keyapis-ad-v1-GetMarketplaceCountResponse)
 Ответ на запрос получения количества маркетплейсов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-GetMarketplaceCountResponse-data"></a> [data](#keyapis-ad-v1-GetMarketplaceCountResponse-data) | Всего маркетплейсов |  optional  [int32](#scalar-types) | <nil>|






<a name="keyapis-ad-v1-GetMarketplaceListRequest"></a>


### [GetMarketplaceListRequest](#keyapis-ad-v1-GetMarketplaceListRequest)
 Запрос получения списка маркетплейсов






<a name="keyapis-ad-v1-GetMarketplaceListResponse"></a>


### [GetMarketplaceListResponse](#keyapis-ad-v1-GetMarketplaceListResponse)
 Ответ на запрос получения списка маркетплейсов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-GetMarketplaceListResponse-data"></a> [data](#keyapis-ad-v1-GetMarketplaceListResponse-data) | Маркетплейс |  optional  [keyapis.ad.v1.Marketplace](#keyapis-ad-v1-Marketplace) | <nil>|






<a name="keyapis-ad-v1-GetMarketplaceRequest"></a>


### [GetMarketplaceRequest](#keyapis-ad-v1-GetMarketplaceRequest)
 Запрос получения маркетплейса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-GetMarketplaceRequest-id"></a> [id](#keyapis-ad-v1-GetMarketplaceRequest-id) | Идентификатор маркетплейса |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-ad-v1-GetMarketplaceResponse"></a>


### [GetMarketplaceResponse](#keyapis-ad-v1-GetMarketplaceResponse)
 Ответ на запрос получения маркетплейса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-GetMarketplaceResponse-data"></a> [data](#keyapis-ad-v1-GetMarketplaceResponse-data) | Маркетплейс |  optional  [keyapis.ad.v1.Marketplace](#keyapis-ad-v1-Marketplace) | <nil>|






<a name="keyapis-ad-v1-Marketplace"></a>


### [Marketplace](#keyapis-ad-v1-Marketplace)
 Маркетплейс


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-Marketplace-id"></a> [id](#keyapis-ad-v1-Marketplace-id) | Идентификатор |    [int32](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-ad-v1-Marketplace-title"></a> [title](#keyapis-ad-v1-Marketplace-title) | Название |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-ad-v1-Marketplace-type"></a> [type](#keyapis-ad-v1-Marketplace-type) | Тип маркетплейса |    [keyapis.ad.v1.Marketplace.Type](#keyapis-ad-v1-Marketplace-Type) | REQUIRED|
| <a id="keyapis-ad-v1-Marketplace-is_disabled"></a> [is_disabled](#keyapis-ad-v1-Marketplace-is_disabled) | Выключен ли маркетплейс |    [bool](#scalar-types) | <nil>|
| <a id="keyapis-ad-v1-Marketplace-card_url"></a> [card_url](#keyapis-ad-v1-Marketplace-card_url) | Ссылка на карточку товара ключа в маркетплейсе |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-ad-v1-Marketplace-created_at"></a> [created_at](#keyapis-ad-v1-Marketplace-created_at) | Дата создания |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-ad-v1-Marketplace-changed_at"></a> [changed_at](#keyapis-ad-v1-Marketplace-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|






<a name="keyapis-ad-v1-PostMarketplaceRequest"></a>


### [PostMarketplaceRequest](#keyapis-ad-v1-PostMarketplaceRequest)
 Запрос сохранения маркетплейса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-PostMarketplaceRequest-data"></a> [data](#keyapis-ad-v1-PostMarketplaceRequest-data) | Маркетплейс |    [keyapis.ad.v1.Marketplace](#keyapis-ad-v1-Marketplace) | REQUIRED|






<a name="keyapis-ad-v1-PostMarketplaceResponse"></a>


### [PostMarketplaceResponse](#keyapis-ad-v1-PostMarketplaceResponse)
 Ответ на запрос сохранения маркетплейса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ad-v1-PostMarketplaceResponse-data"></a> [data](#keyapis-ad-v1-PostMarketplaceResponse-data) | Маркетплейс |  optional  [keyapis.ad.v1.Marketplace](#keyapis-ad-v1-Marketplace) | <nil>|





 <!-- end messages -->



<a name="keyapis-ad-v1-Marketplace-Type"></a>

### [Marketplace.Type](#keyapis-ad-v1-Marketplace-Type)
 Справочник типов маркетплейсов

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-ad-v1-Marketplace-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-ad-v1-Marketplace-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-ad-v1-Marketplace-Type-OZON"></a> [OZON](#keyapis-ad-v1-Marketplace-Type-OZON) | Озон |
| 2 | <a id="keyapis-ad-v1-Marketplace-Type-WILDBERRIES"></a> [WILDBERRIES](#keyapis-ad-v1-Marketplace-Type-WILDBERRIES) | Вайлдберриз |
| 3 | <a id="keyapis-ad-v1-Marketplace-Type-YANDEX_MARKET"></a> [YANDEX_MARKET](#keyapis-ad-v1-Marketplace-Type-YANDEX_MARKET) | Яндекс маркет |
| 4 | <a id="keyapis-ad-v1-Marketplace-Type-SBER_MARKET"></a> [SBER_MARKET](#keyapis-ad-v1-Marketplace-Type-SBER_MARKET) | Яндекс маркет |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |