get

Возвращает справочные данные: регионы, часовые пояса, курсы валют, список станций метрополитена, ограничения на значения параметров, внешние сети (SSP), сегменты Крипты для нацеливания по профилю пользователя и др.

  1. Запрос
  2. Ответ
  3. Примеры

Запрос

Структура запроса в формате JSON:

{
  "method": "get",
  "params": { /* params */
    "DictionaryNames": [( "Currencies"
                        | "MetroStations"
                        | "GeoRegions"
                        | "TimeZones"
                        | "Constants"
                        | "AdCategories"
                        | "OperationSystemVersions"
                        | "ProductivityAssertions"
                        | "SupplySidePlatforms"
                        | "Interests"
                        | "AudienceCriteriaTypes"
                        | "AudienceDemographicProfiles"
                        | "AudienceInterests" ), ... ] /* required */
  }
}
ПараметрТипОписаниеОбяза-тельный
Структура params (для JSON) / GetRequest (для SOAP)
DictionaryNamesarray of DictionaryNameEnumИмена справочников, которые требуется получить.Да

Ответ

Структура ответа в формате JSON:

{
  "result": {
    "Currencies": [{  /* CurrenciesItem */
      "Currency": (string), /* required */
      "Properties": [{  /* ConstantsItem */
        "Name": (string), /* required */
        "Value": (string) /* required */
      }, ... ] /* required */
    }, ... ],
    "MetroStations": [{  /* MetroStationsItem */
      "GeoRegionId": (long), /* required */
      "MetroStationId": (long), /* required */
      "MetroStationName": (string) /* required */
    }, ... ],
    "GeoRegions": [{  /* GeoRegionsItem */
      "GeoRegionId": (long), /* required */
      "GeoRegionName": (string), /* required */
      "GeoRegionType": (string), /* required */
      "ParentId": (long) /* nillable */  
    }, ... ],
    "TimeZones": [{  /* TimeZonesItem */
      "TimeZone": (string), /* required */
      "TimeZoneName": (string), /* required */
      "UtcOffset": (int) /* required */
    }, ... ],
    "Constants": [{  /* ConstantsItem */
      "Name": (string), /* required */
      "Value": (string) /* required */
    }, ... ],
    "AdCategories": [{  /* AdCategoriesItem */
      "AdCategory": (string), /* required */
      "Description": (string), /* required */
      "Message": (string) /* required */
    }, ... ],
    "OperationSystemVersions": [{  /* OperationSystemVersionsItem */
      "OsName": (string), /* required */
      "OsVersion": (string) /* required */
    }, ... ],
    "SupplySidePlatforms": [{  /* SupplySidePlatformsItem */
      "Title": (string) /* required */
    }, ... ],
    "Interests": [{  /* InterestsItem */
      "InterestId": (long),
      "ParentId": (long),
      "Name": (string),
      "IsTargetable": ( "YES" | "NO" )
    }, ... ],
    "AudienceCriteriaTypes": [{ /* AudienceCriteriaTypesItem */
      "Type": (string), /* required */
      "BlockElement": (string),  /* required */
      "Name": (string),  /* required */
      "Description": (string),  /* required */
      "CanSelect": ( "ALL" | "EXCEPT_ALL" ) /* required */
    }, ... ],
    "AudienceDemographicProfiles": [{ /* AudienceDemographicProfilesItem */
      "Id": (long), /* required */
      "Type": (string), /* required */
      "Name": (string), /* required */
      "Description": (string) /* required */
    }, ... ],
    "AudienceInterests": [{ /* AudienceInterestsItem */
      "InterestKey": (long), /* required */
      "Id": (long), /* required */
      "ParentId": (long), /* required */
      "Name": (string), /* required */
      "Description": (string), /* required */
      "InterestType": ( "SHORT_TERM" | "LONG_TERM" | "ANY" )  /* required */
    }, ... ]
  }
}
ПараметрТипОписание
Структура result (для JSON) / GetResponse (для SOAP)
AdCategoriesarray of AdCategoriesItem

Особые категории рекламируемых товаров и услуг.

См. раздел Особая категория.

Constantsarray of ConstantsItemОграничения на значения параметров.
Currenciesarray of CurrenciesItemКурсы валют, валютные параметры и ограничения.
GeoRegionsarray of GeoRegionsItemРегионы.
MetroStationsarray of MetroStationsItemСтанции метрополитена (только для Москвы, Санкт-Петербурга и Киева).
OperationSystemVersionsarray of OperationSystemVersionsItemВерсии операционных систем для рекламы мобильных приложений.
ProductivityAssertionsarray of ProductivityAssertionsItemПараметр утратил актуальность и не возвращается.
TimeZonesarray of TimeZonesItemЧасовые пояса.
SupplySidePlatformsarray of SupplySidePlatformsItemВнешние сети (SSP).
Interestsarray of InterestsItemИнтересы к категориям мобильных приложений.
AudienceCriteriaTypesarray of AudienceCriteriaTypesItemСоциально-демографические характеристики и поведенческие признаки.
AudienceDemographicProfilesarray of AudienceDemographicProfilesItemСегменты по социально-демографическим характеристикам и поведенческим признакам для таргетинга по профилю пользователя.
AudienceInterestsarray of AudienceInterestsItemСегменты по интересам пользователя для таргетинга по профилю пользователя.
Структура AdCategoriesItem
AdCategorystringОбозначение особой категории (параметр объявления AdCategories).
Descriptionstring

Краткое описание особой категории на языке, указанном в запросе в HTTP-заголовке Accept-Language.

Messagestring

Текст предупреждения, автоматически добавляемого в объявление, на языке, указанном в запросе в HTTP-заголовке Accept-Language (см. раздел Предупреждения и возрастные ограничения в объявлениях помощи Директа).

Структура ConstantsItem (для ограничений на значения параметров)
Namestring

Наименование ограничения:

  • MaximumAdTextLength — устарело, рекомендуем использовать MaximumTextAdTextLength.

  • MaximumAdTextWordLength — максимальное количество символов в каждом слове в тексте объявления.

  • MaximumAdTitleLength — устарело, рекомендуем использовать MaximumTextAdTitleLength.

  • MaximumAdTitleWordLength — максимальное количество символов в каждом слове в заголовке объявления.

  • MaximumDynamicTextAdTextLength — максимальное количество символов в тексте динамического объявления без учета «узких».

  • MaximumMobileAppAdTextLength — максимальное количество символов в тексте объявления для рекламы мобильных приложений.

  • MaximumMobileAppAdTitleLength — максимальное количество символов в заголовке объявления для рекламы мобильных приложений.

  • MaximumNumberOfNarrowCharacters — максимальное количество «узких» символов в заголовке или в тексте объявления.

  • MaximumSitelinkDescriptionLength — максимальное количество символов в описании быстрой ссылки.

  • MaximumSitelinksLength — максимальное суммарное количество символов в текстах всех быстрых ссылок в наборе.

  • MaximumSitelinksNumber — максимальное количество быстрых ссылок в наборе.

  • MaximumSitelinkTextLength — максимальное количество символов в тексте быстрой ссылки.

  • MaximumTextAdTextLength — максимальное количество символов в тексте текстово-графического объявления без учета «узких».

  • MaximumTextAdTitleLength — максимальное количество символов в заголовке 1 текстово-графического объявления без учета «узких».

  • MaximumTextAdTitle2Length — максимальное количество символов в заголовке 2 текстово-графического объявления без учета «узких».

Valuestring

Значение ограничения.

Структура CurrenciesItem
CurrencystringОбозначение валюты (параметр кампании Currency).
Propertiesarray of ConstantsItem

Наименование и значение валютного параметра.

Структура ConstantsItem
Namestring

Наименование валютного параметра:

  • FullName — название валюты на языке, указанном в запросе в HTTP-заголовке Accept-Language;
  • BidIncrement — шаг торгов;
  • MaximumBid — максимальная ставка за клик (техническое ограничение);
  • MaximumCPM — максимальная ставка или цена за тысячу показов для медийной рекламы;
  • MinimumAverageCPA — минимальное значение средней цены конверсии для стратегии AVERAGE_CPA, минимальное значение средней цены установки для стратегии AVERAGE_CPI;
  • MinimumAverageCPC — минимальное значение средней цены клика для стратегий AVERAGE_CPC, WEEKLY_CLICK_PACKAGE;
  • MinimumBid — минимальная ставка за клик;
  • MinimumCPM — минимальная ставка или цена за тысячу показов для медийной рекламы;
  • MinimumDailyBudget — минимальный дневной бюджет кампании;
  • MinimumPayment — минимальный платеж (без учета НДС), минимальный дневной бюджет общего счета;
  • MinimumTransferAmount — минимальная сумма перевода между кампаниями;
  • MinimumWeeklySpendLimit — минимальный недельный бюджет.

См. примеры ниже.

Valuestring

Значение валютного параметра.

Внимание. Все возвращаемые денежные значения представляют собой целые числа — результат умножения ставки или цены на 1 000 000.
Структура GeoRegionsItem
GeoRegionIdlongИдентификатор региона.
GeoRegionNamestring

Название региона на языке, указанном в запросе в HTTP-заголовке Accept-Language.

GeoRegionTypestringТип региона: World, Continent, Region, Country, Administrative area, District, City, City district, Village.
ParentIdlong, nillableИдентификатор вышестоящего региона.
Структура MetroStationsItem
GeoRegionIdlongИдентификатор региона.
MetroStationIdlongИдентификатор станции метрополитена (параметр виртуальной визитки MetroStationId).
MetroStationNamestringНазвание станции (на русском языке).
Структура OperationSystemVersionsItem
OsNamestringНазвание операционной системы.
OsVersionstringВерсия операционной системы.
Структура TimeZonesItem
TimeZonestringОбозначение часового пояса (параметр кампании TimeZone).
TimeZoneNamestringОписание часового пояса на языке, указанном в запросе в HTTP-заголовке Accept-Language.
UtcOffsetintСмещение от UTC в секундах.
Структура SupplySidePlatformsItem
TitlestringНаименование внешней сети.
Структура InterestsItem
InterestIdlongИдентификатор интереса к категории мобильных приложений.
ParentIdlongИдентификатор вышестоящего интереса.
Namestring

Название интереса на языке, указанном в запросе в HTTP-заголовке Accept-Language.

IsTargetableYesNoEnumПризнак того, что идентификатор интереса можно указывать в условии нацеливания на аудиторию.
Структура AudienceCriteriaTypesItem
TypestringИдентификатор социально-демографической характеристики или поведенческого признака.
BlockElementstringГруппа характеристик, к которой относится характеристика:
  • SOCIAL — пол, возраст, доход.
  • EXTENDED_SOCIAL — семейное положение, дети, профессия.
  • BEHAVIORAL_INDICATORS — поведенческие признаки.
Namestring

Название характеристики или признака на языке, указанном в запросе в HTTP-заголовке Accept-Language.

DescriptionstringОписание характеристики или признака на языке, указанном в запросе в HTTP-заголовке Accept-Language.
CanSelectCanSelectEnumДопустимо ли указать в правиле отбора пользователей все сегменты по данной характеристике или признаку (например, указать все возрастные группы нельзя, а все профессии можно).
Структура AudienceDemographicProfilesItem
IdlongИдентификатор сегмента по социально-демографической характеристике или поведенческому признаку.
TypestringИдентификатор социально-демографической характеристики или поведенческого признака (параметр TypeId структуры AudienceCriteriaTypes).
Namestring

Название сегмента на языке, указанном в запросе в HTTP-заголовке Accept-Language.

DescriptionlongОписание сегмента на языке, указанном в запросе в HTTP-заголовке Accept-Language.
Структура AudienceInterestsItem
InterestKeylongИдентификатор интереса пользователя.
Idlong

Идентификатор сегмента по интересам пользователя.

Идентификатор сегмента состоит из префикса, обозначающего тип интереса, и идентификатора интереса. Например, InterestKey равен 2499001182 (авиабилеты), а Id равен 102499001182 (краткосрочный интерес к авиабилетам).

ParentIdlongИдентификатор вышестоящего сегмента.
Namestring

Название сегмента на языке, указанном в запросе в HTTP-заголовке Accept-Language.

DescriptionlongОписание сегмента на языке, указанном в запросе в HTTP-заголовке Accept-Language
InterestTypeInterestTypeEnumТип интереса: краткосрочный, долгосрочный или за любой период.

Примеры

Пример запроса: получение справочника валют
{
  "method": "get",
  "params": {
    "DictionaryNames": [ "Currencies" ]
  }
}
Пример ответа
{
  "result": {
    "Currencies": [
      {
        "Currency":"RUB",
        "Properties": [
          { "Name": "FullName",                "Value": "российские рубли" },
          { "Name": "BidIncrement",            "Value": "100000" },
          { "Name": "MaximumBid",              "Value": "25000000000" },
          { "Name": "MaximumCPM",              "Value": "3000000000" },
          { "Name": "MinimumAverageCPA",       "Value": "900000" },
          { "Name": "MinimumAverageCPC",       "Value": "900000" }, 
          { "Name": "MinimumBid",              "Value": "300000" },
          { "Name": "MinimumCPM",              "Value": "5000000" },
          { "Name": "MinimumDailyBudget",      "Value": "300000000" }, 
          { "Name": "MinimumPayment",          "Value": "1000000000" },  
          { "Name": "MinimumTransferAmount",   "Value": "1000000000" },
          { "Name": "MinimumWeeklySpendLimit", "Value": "300000000" }
        ]
      },
      ...
      {
        "Currency": "EUR",
        "Properties": [
          { "Name": "FullName",                "Value": "евро" },
          { "Name": "BidIncrement",            "Value": "10000" },
          { "Name": "MaximumBid",              "Value": "500000000" },
          { "Name": "MaximumCPM",              "Value": "44000000" },
          { "Name": "MinimumAverageCPA",       "Value": "30000" },
          { "Name": "MinimumAverageCPC",       "Value": "30000" },
          { "Name": "MinimumBid",              "Value": "10000" },
          { "Name": "MinimumCPM",              "Value": "70000" },
          { "Name": "MinimumDailyBudget",      "Value": "10000000" },
          { "Name": "MinimumPayment",          "Value": "15000000" },
          { "Name": "MinimumTransferAmount",   "Value": "15000000" },
          { "Name": "MinimumWeeklySpendLimit", "Value": "10000000" }
        ]
      } 
    ]
  }
}