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

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

Request

PUT

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

Path parameters

Name

Description

segmentId

Type: integer

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

Body

application/json

{
  "segment": {
    "name": "example"
  }
}

Name

Description

segment

Type: SegmentName

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

Example

{
  "name": "example"
}

SegmentName

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

Name

Description

name

Type: string

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

Example: example

Example

{
  "name": "example"
}

Responses

200 OK

Body

application/json

{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0,
    "app_metrica_segment_type": "example",
    "app_metrica_segment_id": 0,
    "pattern": "example"
  }
}

Name

Description

segment

One of 7 types

Type: AppMetricaSegment

Сегмент, импортируемый из AppMetrica.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0,
  "pattern": "example"
}

Type: GeoSegment

Сегмент на основе данных о геолокации по окружностям.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "form": "example",
  "pattern": "example",
  "too_much_data": true
}

Type: LookalikeSegment

Сегмент из пользователей, "похожих" на другой сегмент клиента (технология Look-alike).

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

Type: MetrikaSegment

Сегмент, импортируемый из Яндекс Метрики.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "metrika_segment_type": "example",
  "metrika_segment_id": 0,
  "pattern": "example"
}

Type: PixelSegment

Сегмент, созданный по пикселю.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example",
  "pattern": "example"
}

Type: PolygonGeoSegment

Сегмент на основе данных о геолокации по полигонам.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "form": "example",
  "polygons": [
    {
      "points": [
        {},
        {},
        {},
        {}
      ],
      "description": "example"
    }
  ],
  "pattern": "example",
  "too_much_data": true
}

Type: UploadingSegment

Сегмент, созданный из файла с пользовательскими данными.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example",
  "source_id": 0,
  "source_name": "example",
  "item_quantity": 0,
  "valid_unique_quantity": 0,
  "valid_unique_percentage": "example",
  "matched_quantity": 0,
  "matched_percentage": "example",
  "counter_id": 0,
  "uploading_last_modify_time": "2025-01-01T00:00:00Z",
  "device_matching_type": "example"
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0,
  "pattern": "example"
}

BaseSegment

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

Name	Description
name	Type: string Название сегмента. Example: `example`
create_time	Type: string<date-time> Время создания сегмента. Example: `2025-01-01T00:00:00Z`
id	Type: integer Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
owner	Type: string Логин владельца сегмента. Example: `example`
status	Type: string Статус обработки сегмента. Допустимые значения: `uploaded` — сегмент с данными пользователя загружен. `is_processed` — сегмент с заданными параметрами обрабатывается. `processed` — загрузка и обработка сегмента завершена. Сегмент готов для работы. `processing_failed` — обработка сегмента завершилась с ошибкой. `is_updated` — сегмент обновляется. `few_data` — сегмент содержит мало данных для работы. Example: `example`
type	Type: string Тип сегмента. Допустимые значения: `uploading` — сегмент, созданный из файла с пользовательскими данными. `metrika` — сегмент, импортируемый из Яндекс Метрики. `appmetrica` — сегмент, импортируемый из AppMetrica. `lookalike` — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike). `geo` — сегмент на основе данных о геолокации по полигонам и по окружностям. `pixel` — сегмент, созданный по пикселю. Example: `example`

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

AppMetricaSegment

Сегмент, импортируемый из AppMetrica.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

app_metrica_segment_id

Type: integer

Идентификатор объекта из AppMetrica.

app_metrica_segment_type

Type: string

Вид объекта в AppMetrica. Допустимые значения:

api_key — приложение.
segment_id — сегмент.

Example: example

Example

{
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0
}

GeoSegment

Сегмент на основе данных о геолокации по окружностям.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

geo_segment_type

Type: string

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

last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад.
regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней.
home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории.
work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории.
condition — условие "Пользователь посетил указанные места N раз за период". В сегмент попадут пользователи, которые выполнили заданное условие.

Example: example

period_length

Type: integer

Период посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Допустимые значения периода (в сутках): от 1 до 90 (включительно).

times_quantity

Type: integer

Частота посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период".

Примечание

Учитывается только одно посещение в сутки.

Example

{
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0
}

LookalikeSegment

Сегмент из пользователей, "похожих" на другой сегмент клиента (технология Look-alike).

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

lookalike_link	Type: integer Идентификатор сегмента, на который должен быть похож созданный сегмент.
lookalike_value	Type: integer Степень "похожести". Принимает значения 1 2 3 4 5.
maintain_device_distribution	Type: boolean Распределение пользователей по типу устройств. Допустимые значения: `true` — распределение пользователей по типу устройств сохраняется, если это возможно. `false` — распределение пользователей по типу устройств не сохраняется. Значение по умолчанию: `true`.
maintain_geo_distribution	Type: boolean Распределение пользователей по городу. Допустимые значения: `true` — распределение пользователей по городу сохраняется, если это возможно. `false` — распределение пользователей по городу не сохраняется. Значение по умолчанию: `true`.

Example

{
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

MetrikaSegment

Сегмент, импортируемый из Яндекс Метрики.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

metrika_segment_id

Type: integer

Идентификатор объекта из Метрики.

metrika_segment_type

Type: string

Вид объекта в Метрике. Допустимые значения:

counter_id — счетчик.
goal_id — цель.
segment_id — сегмент.

Example: example

Example

{
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "metrika_segment_type": "example",
  "metrika_segment_id": 0
}

PixelSegment

Сегмент, созданный по пикселю.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

period_length	Type: integer Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
pixel_id	Type: integer Идентификатор пикселя.
times_quantity	Type: integer Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Type: string Условие попадания пользователей в сегмент из пикселя. Допустимые значения: `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. `eq` — равно. Пользователь был замечен пикселем M раз за период. `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период. Example: `example`
utm_campaign	Type: string Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_content	Type: string Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_medium	Type: string Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_source	Type: string Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`
utm_term	Type: string Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя. Example: `example`

Example

{
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "pixel_id": 0,
  "period_length": 0,
  "times_quantity": 0,
  "times_quantity_operation": "example",
  "utm_source": "example",
  "utm_content": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_medium": "example"
}

GeoPoint

Координаты точек.

Name	Description
description	Type: string Произвольный комментарий, длина которого не превышает 200. Min length: `0` Max length: `200` Example: `example`
latitude	Type: number Широта.
longitude	Type: number Долгота.

Example

{
  "latitude": 0.5,
  "longitude": 0.5,
  "description": "example"
}

GeoPolygon

Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.

Name

Description

points

Type: GeoPoint[]

Min items: 4

Max items: 2147483647

Example

[
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  }
]

Example

{
  "points": [
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    }
  ]
}

PolygonGeoSegment

Сегмент на основе данных о геолокации по полигонам.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

geo_segment_type	Type: string Тип координат. Допустимые значения: `last` — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. `regular` — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. `home` — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. `work` — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. `condition` — условие "Пользователь посетил указанные места N раз за период". В сегмент попадут пользователи, которые выполнили заданное условие. Example: `example`
period_length	Type: integer Период посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Допустимые значения периода (в сутках): от 1 до 90 (включительно).
polygons	Type: GeoPolygon[] Example `[ { "points": [ { "latitude": 0.5, "longitude": 0.5, "description": "example" }, { "latitude": 0.5, "longitude": 0.5, "description": "example" }, { "latitude": 0.5, "longitude": 0.5, "description": "example" }, { "latitude": 0.5, "longitude": 0.5, "description": "example" } ], "description": "example" } ]`
times_quantity	Type: integer Частота посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Примечание Учитывается только одно посещение в сутки.

Example

{
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "polygons": [
    {
      "points": [
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        }
      ],
      "description": "example"
    }
  ]
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "polygons": [
    {
      "points": [
        {},
        {},
        {},
        {}
      ],
      "description": "example"
    }
  ]
}

UploadingSegment

Сегмент, созданный из файла с пользовательскими данными.

All of 2 types

Type: BaseSegment

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

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}

Type: object

content_type	Type: string Вид содержимого файла. Допустимые значения: `idfa_gaid` — идентификаторы устройств. `mac` — MAC-адреса. `crm` — CRM-данные. Example: `example`
device_matching_type	Type: string Режим поиска устройств для сегмента. Допустимые значения: `CROSS_DEVICE` — включает в сегмент другие устройства того же пользователя, связанные с загруженным ID. Значение по-умолчанию, если режим поиска не выбран. `IN_DEVICE` — сегмент строится только по загруженным устройствам, без расширения на другие устройства. На данный момент режим `IN_DEVICE` доступен только для `idfa_gaid` сегментов. Example: `example`
hashed	Type: boolean Является ли захешированной каждая строка загруженного файла. Допустимые значения: `true` — строка захеширована. `false` — строка не захеширована.
used_hashing_alg	Type: string Алгоритм хеширования примененный для данных, отправляется для `hashed: true`. Допустимое значение: `SHA256`. С 1 января 2025 года загрузка новых хешей MD5 не поддерживается. Для загрузки данных используйте SHA‑256. Example: `example`

Example

{
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example",
  "device_matching_type": "example"
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example",
  "device_matching_type": "example"
}

Была ли статья полезна?

Описание ошибок

Удаление сегмента