Создание партнерских ссылок Яндекс Маркета

Описание

GET /partner/link/create

Возвращает партнерскую ссылку. Она содержит переданный вами URL страницы Яндекс Маркета и необходимые дополнительные GET‑параметры. Такую ссылку вы можете разместить на своей площадке, чтобы получать вознаграждение за заказы на Яндекс Маркете.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/partner/link/create

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

Параметр

Тип

Значение

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

url

String

URL страницы Яндекс Маркета.

Это может быть любая страница Яндекс Маркета: карточка товара, страница категории или магазина, страница с результатами поиска Яндекс Маркета и т. д.

Если вы хотите передать URL, который содержит в себе GET‑параметры, его нужно закодировать в UTF‑8. Для этого вы можете воспользоваться специальным сервисом, например, URL Encode или URL Encode Online.

clid

Int64

Ваш идентификатор в партнерской сети.

Передайте идентификатор CLID, который соответствует партнерским ссылкам Яндекс Маркета и с которым связан указанный в запросе авторизационный ключ. Идентификатор можно найти в интерфейсе Яндекс.Дистрибуции, на странице Продукты, или узнать у персонального менеджера.

В запросе можно передать только один идентификатор.

Необязательные

vid

String

Дополнительный идентификатор партнерской ссылки.

С помощью идентификатора VID можно отслеживать данные отдельно по каждой партнерской ссылке Яндекс Маркета или сравнивать статистику по всем ссылкам на разных страницах. Подробнее о VID см. в разделе Дополнительный идентификатор инструмента VID Справки партнерской сети.

Если идентификатор указан в запросе, партнерская ссылка будет содержать этот VID. По умолчанию возвращаются ссылки без дополнительных идентификаторов.

В запросе можно передать только один дополнительный идентификатор VID.

format

Enum

Формат выходных данных:

  • json
  • xml

Значение по умолчанию: json.

erid

String

Идентификатор рекламы ERID, который вы получили при регистрации креатива в ОРД Яндекса.

Статья «Маркировка рекламы через API Дистрибуции» в Справке партнерской сети Яндекс Маркета.

В ответе добавляется к ссылкам marketUrl, url и shortUrl.

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

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

{
  "status": "{enum}",
  "context":
  {
    "id": "{string}",
    "time": "{date}",
    "marketUrl": "{string}",
    "region":
    {
      "id": {int32},
      "name": "{string}",
      "type": "{enum}",
      "childCount": {int32},
      "country":
      {
        "id": {int32},
        "name": "{string}",
        "type": "{enum}",
        "childCount": {int32}
      }
    },
    "currency": 
    {
      "id": "{enum}",
      "name": "{string}"
    }    
  },
  "link":
  {
    "url": "{string}",
    "shortUrl": "{string}",
    "searchType": "{enum}",
    "pageName": "{string}",
    "productPhoto": "{string}"
  }
}

<result status="{enum}">
  <context id="{string}" time="{date}" marketUrl="{string}">
    <region id="{int32}" name="{string}" type="{enum}" childCount="{int32}">
      <country id="{int32}" name="{string}" type="{enum}" childCount="{int32}"/>
    </region>
    <currency id="{enum}" name="{string}"/>
  </context>
  <link url="{string}" shortUrl="{string}" searchType="{enum}" pageName="{string}" productPhoto="{string}"/>
</result>

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

Параметр для формата JSON

Параметр для формата XML

Тип

Описание

result

Ответ.

Параметр возвращается только для формата XML.

Параметры, вложенные в result

status

status

Enum

Статус выполнения запроса:

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

Для формата XML является атрибутом параметра result.

context

context

Информация о запросе.

link

link

Информация о созданной партнерской ссылке и странице, на которую ссылка ведет.

Параметры, вложенные в context

id

id

String

Идентификатор запроса.

Для формата XML является атрибутом параметра context.

time

time

Date

Дата и время выполнения запроса.

Формат даты: ISO 8601 с миллисекундами и смещением относительно UTC. Например, 2017-11-21T00:00:00.000+03:00.

Для формата XML является атрибутом параметра context.

marketUrl

marketUrl

String

URL Яндекс Маркета.

Содержит GET‑параметры, которые используются в партнерских ссылках. В конце ссылки добавляется идентификатор рекламы ERID.

Для формата XML является атрибутом параметра context.

region

region

Регион, для которого возвращаются данные.

currency

currency

Валюта региона, для которого возвращаются данные.

Параметры, вложенные в region

id

id

Int32

Идентификатор региона.

Для формата XML является атрибутом параметра region.

name

name

String

Название региона.

Для формата XML является атрибутом параметра region.

type

type

Enum

Тип региона:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого‑либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра region.

childCount

childCount

Int32

Количество дочерних регионов.

Для формата XML является атрибутом параметра region.

country

country

Страна, в которой расположен регион.

Параметры, вложенные в country

id

id

Int32

Идентификатор страны.

Для формата XML является атрибутом параметра country.

name

name

String

Название страны.

Для формата XML является атрибутом параметра country.

type

type

Enum

Тип региона:

  • COUNTRY — страна.

Для формата XML является атрибутом параметра country.

childCount

childCount

Int32

Количество дочерних регионов.

Для формата XML является атрибутом параметра country.

Параметры, вложенные в currency

id

id

Enum

Код валюты:

  • RUR — российский рубль.

name

name

String

Название валюты.

Параметры, вложенные в link

url

url

String

Партнерская ссылка.

В конце ссылки добавляется идентификатор рекламы ERID.

shortUrl

shortUrl

String

Короткая партнерская ссылка.

Ведет на ту же страницу и внутри себя содержит такие же дополнительные параметры, что и ссылка в url.

В конце ссылки добавляется идентификатор рекламы ERID.

Используйте короткую ссылку, если не хотите оборачивать ее в текст. Так партнерская ссылка займет намного меньше места.

searchType

searchType

Enum

Тип страницы Яндекс Маркета, на которую ведет партнерская ссылка:

  • MARKET_MAIN — главная страница Яндекс Маркета.

  • MARKET_PRODUCT — карточка товара на Яндекс Маркете.

  • MARKET_CATEGORY — страница категории товаров на Яндекс Маркете (пример).

  • MARKET_PRODUCT_CATEGORY_LIST — список определенных товаров в категории на Яндекс Маркете (пример).

  • MARKET_SEARCH_RESULT — страница с результатами поиска Яндекс Маркета.

  • MARKET_PROMO_LANDING — лендинг Яндекс Маркета (например, страница магазина).

  • MARKET_MARKET_JOURNAL — статья в Журнале Яндекс Маркета.

  • MARKET_BRAND — бренд‑зона (страница с информацией о бренде).

pageName

pageName

String

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

productPhoto

productPhoto

String

Ссылка на изображение товара, бренда или магазина (в зависимости от переданного URL).

Ошибки

В случае ошибки сервер возвращает HTTP‑код ответа и краткое описание ошибки.

Примеры

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/link/create'\
'?url=https://market.yandex.ru/product--umnaia-kolonka-yandex-stantsiia-mini/521440226'\
'&clid=2310490'\
'&format=json'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 13 Mar 2021 17:37:54 GMT
Content-Type: application/json;charset=utf-8
...

{
  "status": "OK",
  "context":
  {
    "id": "1615454824097/16eec7ed19f6faefcae6f0623fbd0500",
    "time": "2021-03-13T17:38:01.238+03:00",
    "marketUrl": "https://market.yandex.ru?pp=1001&amp;clid=2357258&amp;mclid=1003&amp;distr_type=7",
    "region":
    {
      "id": 213,
      "name": "Москва",
      "type": "CITY",
      "childCount": 14,
      "country":
      {
        "id": 225,
        "name": "Россия",
        "type": "COUNTRY",
        "childCount": 10
      }
    },
    "currency": 
    {
      "id": "RUR",
      "name": "руб."
    }    
  },
  "link":
  {
    "url": "https://market.yandex.ru/product--umnaia-kolonka-yandex-stantsiia-mini/521440226?clid=2310490&amp;pp=900&amp;mclid=1003&amp;distr_type=7",
    "shortUrl": "https://ya.cc/NhesA",
    "searchType": "MARKET_PRODUCT",
    "pageName": "Умная колонка Яндекс.Станция Мини",
    "productPhoto": "https://avatars.mds.yandex.net/get-mpic/1911047/img_id2701886402505123731.jpeg/orig"
  }
}

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/partner/link/create'\
'?url=https://market.yandex.ru/product--umnaia-kolonka-yandex-stantsiia-mini/521440226'\
'&clid=2310490'\
'&format=xml'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 13 Mar 2021 17:37:54 GMT
Content-Type: application/xml;charset=utf-8
...

<result status="OK">
  <context id="1615454824097/16eec7ed19f6faefcae6f0623fbd0500" time="2021-03-13T17:38:01.238+03:00"
  	  marketUrl="https://market.yandex.ru?pp=1001&amp;clid=2357258&amp;mclid=1003&amp;distr_type=7">
    <region id="213" name="Москва" type="CITY" childCount="14">
      <country id="225" name="Россия" type="COUNTRY" childCount="10"/>
    </region>
    <currency id="RUR" name="руб."/>
  </context>
  <link url="https://market.yandex.ru/product--umnaia-kolonka-yandex-stantsiia-mini/521440226?clid=2310490&amp;pp=900&amp;mclid=1003&amp;distr_type=7"
        shortUrl="https://ya.cc/NhesA" searchType="MARKET_PRODUCT"
        pageName="Умная колонка Яндекс.Станция Мини"
        productPhoto="https://avatars.mds.yandex.net/get-mpic/1911047/img_id2701886402505123731.jpeg/orig"/>
</result>
Предыдущая
Список акций
Следующая
Создание партнерских артикулов