get

Возвращает параметры объявлений, отвечающих заданным критериям.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Метод возвращает не более 10 000 объектов.

Запрос

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

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* AdsSelectionCriteria */
      "Ids": [(long), ... ],
      "States": [( "OFF" | ... | "ARCHIVED" ), ... ],
      "Statuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "Types": [( "TEXT_AD" | "MOBILE_APP_AD" | "DYNAMIC_TEXT_AD" | "IMAGE_AD" | "CPC_VIDEO_AD" | "CPM_BANNER_AD" ), ... ],
      "Mobile": ( "YES" | "NO" ),
      "VCardIds": [(long), ... ],
      "SitelinkSetIds": [(long), ... ],
      "AdImageHashes": [(string), ... ],
      "VCardModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "SitelinksModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "AdImageModerationStatuses": [( "ACCEPTED" | ... | "REJECTED" ), ... ],
      "AdExtensionIds": [(long), ... ]
    }, /* required */
    "FieldNames": [( "AdCategories" | ... | "Subtype" ), ... ], /* required */
    "TextAdFieldNames": [( "AdImageHash" | ... | "TurboPageModeration" ), ... ],
    "TextAdPriceExtensionFieldNames": [( "Price" | "OldPrice" | "PriceCurrency" | "PriceQualifier" ), ... ],
    "MobileAppAdFieldNames": [( "AdImageHash" | ... | "TrackingUrl" ), ... ],
    "DynamicTextAdFieldNames": [( "AdImageHash" | ... | "AdExtensions" ), ... ],
    "TextImageAdFieldNames": [( "AdImageHash" | "Href" | "TurboPageId" | "TurboPageModeration" ), ... ],
    "MobileAppImageAdFieldNames": [( "AdImageHash" | "TrackingUrl" ), ... ],
    "TextAdBuilderAdFieldNames": [( "Creative" | "Href" | "TurboPageId" | "TurboPageModeration" ), ... ],
    "MobileAppAdBuilderAdFieldNames": [( "Creative" | "TrackingUrl" ), ... ],
    "CpcVideoAdBuilderAdFieldNames": [( "Creative" | "Href" | "TurboPageId" | "TurboPageModeration" ), ... ], 
    "CpmBannerAdBuilderAdFieldNames": [( "Creative" | "Href" | "TrackingPixels" | "TurboPageId" | "TurboPageModeration" ), ... ],
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  } 
}

Ниже приведено описание параметров.

Параметр Тип Описание Обязательный
Структура params (для JSON) / GetRequest (для SOAP)
SelectionCriteria AdsSelectionCriteria

Критерий отбора объявлений.

Да
FieldNames array of AdFieldEnum

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

Да
TextAdFieldNames array of TextAdFieldEnum Имена параметров текстово-графического объявления, которые требуется получить. См. Тип объявления.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа, параметры из TextAdFieldNames не возвращаются.
Нет
TextAdPriceExtensionFieldNames TextAdPriceExtensionFieldEnum

Имена параметров цены товара или услуги в текстово-графическом объявлении, которые требуется получить.

Допускается только при наличии параметра TextAdFieldNames.

Нет
MobileAppAdFieldNames array of MobileAppAdFieldEnum Имена параметров объявления для рекламы мобильных приложений, которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа, параметры из MobileAppAdFieldNames не возвращаются.
Нет
DynamicTextAdFieldNames array of DynamicTextAdFieldEnum Имена параметров динамического объявления, которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа, параметры из DynamicTextAdFieldNames не возвращаются.
Нет
TextImageAdFieldNames array of TextImageAdFieldEnum Имена параметров графического объявления, созданного на основе изображения (в группе текстово-графических объявлений), которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа или подтипа, параметры из TextImageAdFieldNames не возвращаются.
Нет
MobileAppImageAdFieldNames array of MobileAppImageAdFieldEnum Имена параметров графического объявления, созданного на основе изображения (в группе для рекламы мобильных приложений), которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа или подтипа, параметры из MobileAppImageAdFieldNames не возвращаются.
Нет
TextAdBuilderAdFieldNames array of TextAdBuilderAdFieldEnum Имена параметров графического объявления, созданного на основе креатива (в группе текстово-графических объявлений), которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа или подтипа, параметры из TextAdBuilderAdFieldNames не возвращаются.
Нет
MobileAppAdBuilderAdFieldNames array of MobileAppAdBuilderAdFieldEnum Имена параметров графического объявления, созданного на основе креатива (в группе для рекламы мобильных приложений), которые требуется получить.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа или подтипа, параметры из MobileAppAdBuilderAdFieldNames не возвращаются.
Нет
CpcVideoAdBuilderAdFieldNames array of CpcVideoAdBuilderAdFieldNames Имена параметров видеообъявления (в кампаниях с типом «Текстово-графические объявления»), которые требуется получить. См.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа или подтипа, параметры из CpcVideoAdBuilderAdFieldNames не возвращаются.
Нет
CpmBannerAdBuilderAdFieldNames array of CpmBannerAdBuilderAdFieldEnum Имена параметров медийного баннера, которые требуется получить. См. Тип объявления.
Примечание. Если согласно SelectionCriteria отобрано объявление другого типа, параметры из CpmBannerAdBuilderAdFieldNames не возвращаются.
Нет
Page LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет
Структура AdsSelectionCriteria
Ids array of long Отбирать объявления с указанными идентификаторами. От 1 до 10 000 элементов в массиве. Хотя бы один из параметров CampaignIds, AdGroupIds и Ids (могут присутствовать все)
AdGroupIds array of long Отбирать объявления указанных групп. От 1 до 1000 элементов в массиве.
CampaignIds array of long Отбирать объявления указанных кампаний. От 1 до 10 элементов в массиве.
States array of AdStateSelectionEnum Отбирать объявления с указанными состояниями. См. Статус и состояние объявления. Нет
Statuses array of AdStatusSelectionEnum Отбирать объявления с указанными статусами. См. Статус и состояние объявления. Нет
Types array of AdTypeEnum

Отбирать объявления с указанными типами. См. Тип объявления.

Примечание. Отбор объявлений по подтипу не поддерживается. При указании значения IMAGE_AD будут получены графические объявления независимо от подтипа.
Нет
Mobile YesNoEnum

Отбирать объявления по признаку того, что объявление является мобильным:

  • YES — мобильные объявления.
  • NO — обычные объявления.

Если задано значение YES, будут получены только текстово-графические объявления. Не следует задавать это значение, если требуется получить объявления других типов.

Нет
VCardIds array of long Отбирать объявления с указанными визитками. От 1 до 50 элементов в массиве.

Если параметр задан, будут получены только текстово-графические объявления и динамические объявления. Не следует задавать его, если требуется получить объявления других типов.

Нет
SitelinkSetIds array of long Отбирать объявления с указанными наборами быстрых ссылок. От 1 до 50 элементов в массиве.

Если параметр задан, будут получены только текстово-графические объявления и динамические объявления. Не следует задавать его, если требуется получить объявления других типов.

Нет
AdImageHashes array of string Отбирать объявления с указанными изображениями. От 1 до 50 элементов в массиве. Нет
VCardModerationStatuses array of ExtensionStatusSelectionEnum Отбирать объявления по результату модерации визитки. Описание статусов см. в разделе Дополнения к объявлению.

Если параметр задан, будут получены только текстово-графические объявления и динамические объявления. Не следует задавать его, если требуется получить объявления других типов.

Нет
SitelinksModerationStatuses array of ExtensionStatusSelectionEnum Отбирать объявления по результату модерации набора быстрых ссылок. Описание статусов см. в разделе Дополнения к объявлению.

Если параметр задан, будут получены только текстово-графические объявления и динамические объявления. Не следует задавать его, если требуется получить объявления других типов.

Нет
AdImageModerationStatuses array of ExtensionStatusSelectionEnum Отбирать объявления по результату модерации изображения. Описание статусов см. в разделе Дополнения к объявлению.

Если параметр задан, будут получены только текстово-графические объявления, динамические объявления и объявления для рекламы мобильных приложений. Не следует задавать его, если требуется получить объявления других типов.

Нет
AdExtensionIds array of long Отбирать объявления с указанными расширениями. От 1 до 50 элементов в массиве.

Если параметр задан, будут получены только текстово-графические объявления и динамические объявления. Не следует задавать его, если требуется получить объявления других типов.

Нет

Ответ

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

{
  "result": { /* result */
    "Ads": [{  /* AdGetItem */
      "Id": (long),
      "CampaignId": (long),
      "AdGroupId": (long),
      "Status": ( "ACCEPTED" | ... | "UNKNOWN" ),
      "State": ( "OFF" | ... | "UNKNOWN" ),
      "StatusClarification": (string),
      "AdCategories": {  /* ArrayOfAdCategoryEnum */
        "Items": [( "ABORTION" | ... | "TOBACCO" ), ... ] /* required */
      }, /* nillable */ 
      "AgeLabel": ( "AGE_0" | ... | "MONTHS_12"), /* nillable */
      "Type": ( "TEXT_AD" | "MOBILE_APP_AD" | "DYNAMIC_TEXT_AD" | "IMAGE_AD" | "CPC_VIDEO_AD" | "CPM_BANNER_AD" ),
      "Subtype": ( "NONE" | "TEXT_IMAGE_AD" | "MOBILE_APP_IMAGE_AD" |  "TEXT_AD_BUILDER_AD" | "MOBILE_APP_AD_BUILDER_AD" ),
      "TextAd": {  /* TextAdGet */
        "Title": (string),
        "Title2": (string), /* nillable */ 
        "Text": (string),
        "Href": (string), /* nillable */ 
        "Mobile": ( "YES" | "NO" ),
        "DisplayDomain": (string), /* nillable */ 
        "DisplayUrlPath": (string), /* nillable */ 
        "VCardId": (long), /* nillable */ 
        "AdImageHash": (string), /* nillable */ 
        "SitelinkSetId": (long), /* nillable */
        "DisplayUrlPathModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "VCardModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "SitelinksModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "AdExtensions": [{  /* AdExtensionAdGetItem */
          "AdExtensionId": (long), /* required */
          "Type": ( "CALLOUT" | "UNKNOWN" ) /* required */
        }, ... ],
        "VideoExtension": {  /* VideoExtensionGetItem */
          "CreativeId": (long), /* required */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ),
          "ThumbnailUrl": (string), /* required */
          "PreviewUrl": (string) /* required */
        }, /* nillable */
        "PriceExtension": {  /* PriceExtensionGetItem */
          "Price": (long), 
          "OldPrice": (long), /* nillable */
          "PriceQualifier": ( "FROM" | "UP_TO" | "NONE" ), 
          "PriceCurrency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" ) 
        }, /* nillable */
        "TurboPageId": (long), /* nillable */ 
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      },
      "DynamicTextAd": {  /* DynamicTextAdGet */
        "VCardId": (long), /* nillable */ 
        "AdImageHash": (string), /* nillable */ 
        "SitelinkSetId": (long), /* nillable */ 
        "VCardModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "SitelinksModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string) 
        }, /* nillable */ 
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        }, /* nillable */ 
        "AdExtensions": [{  /* AdExtensionAdGetItem */
          "AdExtensionId": (long), /* required */
          "Type": ( "CALLOUT" | "UNKNOWN" ) /* required */
        }, ... ],
        "Text": (string)             
      },
      "MobileAppAd": {  /* MobileAppAdGet */
        "Title": (string),
        "Text": (string),
        "TrackingUrl": (string), /* nillable */ 
        "Action": ( "DOWNLOAD" | "GET" | "INSTALL" | "MORE" | "OPEN" | "UPDATE" | "PLAY" | "BUY_AUTODETECT" ),
        "AdImageHash": (string), /* nillable */ 
        "Features": [{  /* MobileAppAdFeatureGetItem */
          "Feature": ( "PRICE" | "ICON" | "CUSTOMER_RATING" | "RATINGS" ), /* required */
          "Enabled": ( "YES" | "NO" ), /* required */
          "IsAvailable": ( "YES" | "NO" | "UNKNOWN" ) /* required */
        }, ... ],
        "AdImageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      }, 
      "TextImageAd": {  /* TextImageAdGet */
        "AdImageHash": (string),
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */ 
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      },
      "MobileAppImageAd": {  /* MobileAppImageAdGet */
        "AdImageHash": (string),
        "TrackingUrl": (string) /* nillable */
      },
      "TextAdBuilderAd": {  /* TextAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        }, 
        "Href": (string), /* nillable */ 
        "TurboPageId": (long), /* nillable */ 
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      },
      "MobileAppAdBuilderAd": {  /* MobileAppAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        }, 
        "TrackingUrl": (string) /* nillable */
      },
      "CpmBannerAdBuilderAd": {  /* CpmBannerAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        },
        "Href": (string), /* nillable */
        "TrackingPixels": { /* TrackingPixelGetArray */
          "Items": [{ /* TrackingPixelGetItem */
            "TrackingPixel": (string), /* required */
            "Provider": (string) /* required */
          }, ... ] /* required */
        }, /* nillable */
        "TurboPageId": (long), /* nillable */ 
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      },
      "CpcVideoAdBuilderAd": {  /* CpcVideoAdBuilderAdGet */
        "Creative": { /* AdBuilderAdGetItem */
          "CreativeId": (long), /* required */
          "ThumbnailUrl": (string),
          "PreviewUrl": (string)
        }, 
        "Href": (string), /* nillable */
        "TurboPageId": (long), /* nillable */ 
        "TurboPageModeration": {  /* ExtensionModeration */
          "Status": ( "ACCEPTED" | ... | "UNKNOWN" ), /* required */
          "StatusClarification": (string)
        } /* nillable */ 
      }
    }, ... ],
    "LimitedBy": (long)
  }
}

Ниже приведено описание параметров.

Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
Ads array of AdGetItem Объявления.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура AdGetItem
Id long Идентификатор объявления.
CampaignId long Идентификатор кампании, к которой относится объявление.
AdGroupId long Идентификатор группы, к которой относится объявление.
Status StatusEnum Статус объявления. Описание статусов см. в разделе Статус и состояние объявления.
State StateEnum Состояние объявления. Описание состояний см. в разделе Статус и состояние объявления.
StatusClarification string

Текстовое пояснение к статусу и/или причины отклонения на модерации.

AdCategories ArrayOfString, nillable Особая категория.
AgeLabel AgeLabelEnum, nillable Возрастная метка.
Type AdTypeEnum Тип объявления. См. Тип объявления.
Subtype AdSubtypeEnum Подтип объявления. Для объявлений с типом, отличным от IMAGE_AD, возвращается значение NONE.
TextAd TextAdGet Параметры текстово-графического объявления.
DynamicTextAd DynamicTextAdGet Параметры динамического объявления.
MobileAppAd MobileAppAdGet Параметры объявления для рекламы мобильных приложений.
TextImageAd TextImageAdGet Параметры графического объявления, созданного на основе изображения (в группе текстово-графических объявлений).
MobileAppImageAd MobileAppImageAdGet Параметры графического объявления, созданного на основе изображения (в группе для рекламы мобильных приложений).
TextAdBuilderAd TextAdBuilderAdGet Параметры графического объявления, созданного на основе креатива (в группе текстово-графических объявлений).
MobileAppAdBuilderAd MobileAppAdBuilderAdGet Параметры графического объявления, созданного на основе креатива (в группе для рекламы мобильных приложений).
CpmBannerAdBuilderAd CpmBannerAdBuilderAdGet Параметры медийного баннера.
CpcVideoAdBuilderAd CpcVideoAdBuilderAdGet Параметры медийного видеообъявления (в кампании с типом «Текстово-графические объявления»).
Структура TextAdGet
Title string

Заголовок 1.

Не более 35 символов без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Title2 string, nillable

Заголовок 2.

Не более 30 символов без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Text string

Текст объявления.

Не более 81 символа без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

Href string, nillable

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Mobile YesNoEnum Признак того, что объявление является мобильным: YES или NO. См. раздел Мобильные объявления помощи Директа.
DisplayDomain string, nillable Рекламируемый домен. Определяется автоматически на основе ссылки объявления.
DisplayUrlPath string, nillable

Отображаемая ссылка. Допускается только при наличии параметра Href. Не более 20 символов. В случае использования шаблона символы # не учитываются в длине.

Может содержать буквы, цифры, символы -, №, /, %, #. Запрещены пробел, символ _, двойные символы --, //.

См. раздел Отображаемая ссылка помощи Директа.

VCardId long, nillable Идентификатор виртуальной визитки. Визитка должна принадлежать той же кампании, что и объявление.
SitelinkSetId long, nillable Идентификатор набора быстрых ссылок. Допускается только при наличии параметра Href или TurboPageId.
AdImageHash string, nillable

Хэш изображения.

Для текстово-графических объявлений подходят только изображения с типом REGULAR и WIDE, см. Тип изображения.
DisplayUrlPathModeration ExtensionModeration, nillable Результат модерации отображаемой ссылки.
VCardModeration ExtensionModeration, nillable Результат модерации визитки.
SitelinksModeration ExtensionModeration, nillable Результат модерации набора быстрых ссылок.
AdImageModeration ExtensionModeration, nillable Результат модерации изображения.
AdExtensions array of AdExtensionAdGetItem Расширения.
VideoExtension VideoExtensionGetItem, nillable

Видеодополнение.

См. раздел Видеодополнения помощи Директа.

PriceExtension PriceExtensionGetItem, nillable Цена в объявлении.
TurboPageId long, nillable Идентификатор Турбо-страницы.
TurboPageModeration ExtensionModeration, nillable Результат модерации Турбо-страницы.
Структура ExtensionModeration
Status StatusEnum Результат модерации связки объявления с указанным дополнительным элементом. Описание статусов см. в разделе Дополнения к объявлению.
StatusClarification string Текстовое пояснение к статусу и/или причины отклонения на модерации.
Структура AdExtensionAdGetItem
AdExtensionId long Идентификатор расширения.
Type AdExtensionTypeEnum Тип расширения. В настоящее время доступен только один тип расширения — «Уточнение» (CALLOUT).
Структура VideoExtensionGetItem
CreativeId long Идентификатор креатива.
Status StatusEnum Результат модерации связки объявления с видеодополнением. Описание статусов см. в разделе Дополнения к объявлению.
ThumbnailUrl string Ссылка на эскиз (изображение) для предварительного просмотра.
PreviewUrl string Ссылка на видео для предварительного просмотра.
Структура PriceExtensionGetItem
Price long

Цена товара или услуги, умноженная на 1 000  000. Целое число, кратное 10 000 (что соответствует цене с двумя знаками после запятой). Максимальное значение — 10 000 000 000 000 000.

OldPrice long, nillable Старая цена товара или услуги, умноженная на 1 000  000. Целое число, кратное 10 000. Старая цена должна быть строго меньше цены.
PriceQualifier PriceQualifierEnum

Текстовое пояснение к цене:

  • FROM — «от».
  • UP_TO — «до».
  • NONE — нет пояснения.
PriceCurrency PriceCurrencyEnum Валюта, в которой указана цена.
Структура DynamicTextAdGet
VCardId long, nillable Идентификатор виртуальной визитки. Визитка должна принадлежать той же кампании, что и объявление.
AdImageHash string, nillable

Хэш изображения.

Для динамических объявлений подходят только изображения с типом REGULAR и WIDE, см. Тип изображения.

SitelinkSetId long, nillable Идентификатор набора быстрых ссылок.
VCardModeration ExtensionModeration, nillable Результат модерации визитки.
SitelinksModeration ExtensionModeration, nillable Результат модерации набора быстрых ссылок.
AdImageModeration ExtensionModeration, nillable Результат модерации изображения.
AdExtensions array of AdExtensionAdGetItem Расширения.
Text string

Текст объявления.

Не более 81 символа без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

Структура MobileAppAdGet
Title string

Заголовок.

Не более 33 символов с учетом «узких». Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Text string

Текст объявления.

Не более 75 символов с учетом «узких». Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

TrackingUrl string, nillable Трекинговая ссылка для отслеживания установок приложения.
Action MobileAppAdActionEnum

Надпись на кнопке:

  • DOWNLOAD — «Загрузить»

  • GET — «Скачать»

  • INSTALL — «Установить»

  • MORE — «Подробнее»

  • OPEN — «Открыть»

  • UPDATE — «Обновить»

  • PLAY — «Играть»

  • BUY_AUTODETECT — надпись зависит о цены приложения: «Купить», если цена отлична от нуля, или «Бесплатно», если цена равна нулю.

AdImageHash string, nillable

Хэш изображения.

Для рекламы мобильных приложений подходят только изображения с типом WIDE, см. Тип изображения.

Features array of MobileAppAdFeatureGetItem Дополнения, которые требуется автоматически загружать из магазина приложений и отображать в объявлении.
AdImageModeration ExtensionModeration, nillable Результат модерации изображения.
Структура MobileAppAdFeatureGetItem
Feature MobileAppFeatureEnum

Тип дополнения:

  • PRICE — цена;
  • ICON — иконка;
  • CUSTOMER_RATING — рейтинг;
  • RATINGS — количество оценок (отображается, только если включено отображение рейтинга).
Примечание. Возвращаются данные о тех дополнениях, которые были указаны при создании или редактировании объявления, а также о дополнениях, которые были загружены из магазина приложений.
Enabled YesNoEnum

Отображать ли дополнение в объявлении.

Примечание.
  • Если дополнение не удалось загрузить из магазина приложений, для него допустимо значение YES, однако это дополнение не отображается при показе объявления.
  • Количество оценок отображается только вместе с рейтингом: если для типа CUSTOMER_RATING задано NO, а для RATINGS — YES, количество оценок не отображается.
IsAvailable YesNoUnknownEnum

Удалось ли загрузить дополнение из магазина приложений:

  • YES — дополнение загружено;
  • NO — дополнение не удалось загрузить;
  • UNKNOWN — попытка загрузить дополнения еще не производилась.
Структура TextImageAdGet
AdImageHash string

Хэш изображения.

Для графических объявлений подходят только изображения с типом FIXED_IMAGE, см. Тип изображения.

Href string, nillable

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

TurboPageId long, nillable Идентификатор Турбо-страницы.
TurboPageModeration ExtensionModeration, nillable Результат модерации Турбо-страницы.
Структура MobileAppImageAdGet
AdImageHash string

Хэш изображения.

Для графических объявлений подходят только изображения с типом FIXED_IMAGE, см. Тип изображения.

TrackingUrl string, nillable Трекинговая ссылка для отслеживания установок приложения.
Структура TextAdBuilderAdGet
Creative AdBuilderAdGetItem

Креатив, созданный в конструкторе креативов.

См. раздел Конструктор креативов для графических объявлений помощи Директа.

Href string, nillable

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

TurboPageId long, nillable Идентификатор Турбо-страницы.
TurboPageModeration ExtensionModeration, nillable Результат модерации Турбо-страницы.
Структура MobileAppAdBuilderAdGet
Creative AdBuilderAdGetItem

Креатив, созданный в конструкторе креативов.

См. раздел Конструктор креативов для графических объявлений помощи Директа.

TrackingUrl string, nillable Трекинговая ссылка для отслеживания установок приложения.
Структура CpmBannerAdBuilderAdGet
Creative AdBuilderAdGetItem

Креатив, загруженный в веб-интерфейсе или созданный в конструкторе креативов.

См. раздел Создание медийной кампании помощи Директа.

Href string, nillable

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

TrackingPixels TrackingPixelGetArray, nillable Пиксель Яндекс.Аудиторий и/или счетчик показов ADFOX.
TurboPageId long, nillable Идентификатор Турбо-страницы.
TurboPageModeration ExtensionModeration, nillable Результат модерации Турбо-страницы.
Структура CpcVideoAdBuilderAdGet
Creative AdBuilderAdGetItem

Креатив, созданный в конструкторе креативов.

См. раздел Видеообъявления / Конструктор креативов помощи Директа.

Href string, nillable

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

TurboPageId long, nillable Идентификатор Турбо-страницы.
TurboPageModeration ExtensionModeration, nillable Результат модерации Турбо-страницы.
Структура AdBuilderAdGetItem
CreativeId long

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

Получить идентификатор креатива можно с помощью метода Creatives.get.

ThumbnailUrl string Ссылка на миниатюру для предварительного просмотра.
PreviewUrl string Ссылка на изображение для предварительного просмотра.
Структура TrackingPixelGetArray
Items array of TrackingPixelGetItem Пиксель и/или счетчик и их провайдеры.
Структура TrackingPixelGetItem
TrackingPixel string Ссылка на пиксель Яндекс.Аудиторий или счетчик показов ADFOX.
Provider string Провайдер пикселя или счетчика показов.