Изменение сегмента

Изменяет указанный сегмент.

Request

PUT

https://api-audience.yandex.ru/v1/management/segment/{segmentId}

Path parameters

Name

Description

segmentId*

Type: integer<int32>

Идентификатор сегмента, который вы хотите изменить.

Body

application/json
{
    "segment": {
        "name": "string"
    }
}

Name

Description

segment

Type: SegmentName

Сегмент с заданными параметрами.

SegmentName

Сегмент с заданными параметрами.

Name

Description

name*

Type: string

Название сегмента.

Responses

200 OK

OK

Body

application/json
{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string"
    }
}

Name

Description

segment

Type: BaseSegment

Тип для описания сегмента.

BaseSegment

Тип для описания сегмента.

Name

Description

name*

Type: string

Название сегмента.

create_time

Type: string<date-time>

Время создания сегмента.

id

Type: integer<int32>

Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.

owner

Type: string

Логин владельца сегмента.

status

Type: string

Статус обработки сегмента. Допустимые значения:

  • uploaded — сегмент с данными пользователя загружен.
  • is_processed — сегмент с заданными параметрами обрабатывается.
  • processed — загрузка и обработка сегмента завершена. Сегмент готов для работы.
  • processing_failed — обработка сегмента завершилась с ошибкой.
  • is_updated — сегмент обновляется.
  • few_data — сегмент содержит мало данных для работы.

type

Type: string

Тип сегмента. Допустимые значения:

  • uploading — сегмент, созданный из файла с пользовательскими данными.
  • metrika — сегмент, импортируемый из Яндекс Метрики.
  • appmetrica — сегмент, импортируемый из AppMetrica.
  • lookalike — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike).
  • geo — cегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

No longer supported, please use an alternative and newer version.