Получение креативов

Описание

GET /marking

Возвращает список зарегистрированных креативов.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/marking

Входные данные

Параметр

Тип

Значение

Обязательный

clid

String

Ваш идентификатор в реферальной программе.

да

page

Int64

Номер страницы. Если параметр не указан, возращается первая страница.

нет

page_size

Int64

Размер страницы. Значение по умолчанию – 30.

нет

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Выходные данные

{
  "data": {
    "count": {integer},
    "countItemsOnPage": {integer},
    "current": {integer},
    "next": {integer},
    "previous": {integer},
    "results": [
      {
        "clid": {integer},
        "token": {string},
        "dt_created": {string},
        "dt_changed": {string},
        "description": {string}
      }
    ]
  },
  "result": "ok"
}      

Описание параметров:

Параметр

Тип

Значение

count

Integer

Количество креативов.

countItemsOnPage

Integer

Количество записей на странице.

current

Integer

Номер текущей страницы.

next

Integer

Номер следующей страницы. Если следующей страницы нет — null.

previous

Integer

Номер предыдущей страницы. Если предыдущей страницы нет — null.

clid

Integer

CLID, к которому относится креатив.

token

String

Токен креатива.

dt_created

String

Дата создания креатива в формате ISO 8601.

dt_changed

String

Дата изменения креатива в формате ISO 8601.

description

String

Описание креатива.

result

String

Статус выполнения запроса. Всегда возвращается ok.

Примеры

Запрос:

curl -i -H "Accept: application/json" -H "Authorization: OAuth 66..." -X GET "https://api.content.market.yandex.ru/v3/affiliate/marking?clid=123456"'

Ответ:

{
  "data": {
    "count": 2,
    "countItemsOnPage": 30,
    "current": 1,
    "next": null,
    "previous": null,
    "results": [
      {
        "clid": 123456,
        "token": "4CQwVszL78EMgDAwBoV",
        "dt_created": "2023-08-26T18:12:15.315552+03:00",
        "dt_changed": "2023-08-26T18:12:19.101429+03:00",
        "description": "Test description"
      },
      {
        "clid": 123456,
        "token": "4CQwVszL78EMgDAvrAo",
        "dt_created": "2023-08-26T17:19:59.515248+03:00",
        "dt_changed": "2023-08-26T17:20:04.495564+03:00",
        "description": "Test description 2"
      }
    ]
  },
  "result": "ok"
}