get
Возвращает данные профилей организаций рекламодателя на Яндексе.
Рекламодатель может получить данные организаций, для которых выполнено хотя бы одно из условий:
- У главного представителя рекламодателя подтверждены права на организацию в Яндекс Справочнике.
- Профиль организации привязан к одному из объявлений рекламодателя.
Если профиль организации не прошел модерацию в Яндекс Справочнике, в параметре IsPublished возвращается значение NO. Профиль такой организации нельзя привязать к объявлению.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* IdsCriteria */
"Ids": [(long), ... ] /* required */
},
"FieldNames": [( "Id" | "Name" | "Address" | "Phone"
| "ProfileUrl" | "InternalUrl" | "IsPublished"
| "MergedIds" | "Rubric" | "Urls"
| "HasOffice" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | IdsCriteria | Критерии отбора профилей организаций. | Нет |
FieldNames | array of BusinessFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура IdsCriteria | |||
Ids | array of long | Идентификаторы профилей организаций, которые требуется получить (не более 10 000). | Да |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | IdsCriteria | Критерии отбора профилей организаций. | Нет |
FieldNames | array of BusinessFieldEnum | Имена параметров, которые требуется получить. | Да |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура IdsCriteria | |||
Ids | array of long | Идентификаторы профилей организаций, которые требуется получить (не более 10 000). | Да |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"Businesses": [{ /* BusinessGetItem */
"Id": (long),
"Name": (string),
"Address": (string), /* nillable */
"Phone": (string),
"ProfileUrl": (string),
"InternalUrl": (string),
"IsPublished": ( "YES" | "NO" ),
"MergedIds": { /* ArrayOfLong */
"Items": [(long), ... ]
},
"Rubric": (string),
"Urls": { /* ArrayOfString */
"Items": [(string), ... ]
},
"HasOffice": ( "YES" | "NO" )
}, ... ],
"LimitedBy": (long)
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Businesses | array of BusinessGetItem | Профили организаций. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура BusinessGetItem | ||
Id | long | Идентификатор профиля организации. |
Name | string | Название организации. |
Address | string, nillable | Адрес организации. |
Phone | string | Телефон организации. |
ProfileUrl | string | Ссылка на профиль организации на Яндексе. |
InternalUrl | string | Ссылка на страницу редактирования организации в Яндекс Справочнике. |
IsPublished | YesNoEnum | Признак того, что профиль организации прошел модерацию в Яндекс Справочнике и опубликован. Профиль организации можно привязать к объявлению, только если для него в параметре IsPublished возвращается значение YES. |
MergedIds | ArrayOfLong | Идентификаторы профилей организаций, которые объединены с основным профилем (идентификатор основного профиля указан в поле Id). Возвращаются только идентификаторы профилей, привязанных к объявлениям рекламодателя, и только если в запросе отсутствовал SelectionCriteria. |
Rubric | string | Род деятельности организации. |
Urls | ArrayOfString | Ссылки на сайт и социальные сети. |
HasOffice | YesNoEnum | Признак того, что организация имеет фактический адрес. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Businesses | array of BusinessGetItem | Профили организаций. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура BusinessGetItem | ||
Id | long | Идентификатор профиля организации. |
Name | string | Название организации. |
Address | string, nillable | Адрес организации. |
Phone | string | Телефон организации. |
ProfileUrl | string | Ссылка на профиль организации на Яндексе. |
InternalUrl | string | Ссылка на страницу редактирования организации в Яндекс Справочнике. |
IsPublished | YesNoEnum | Признак того, что профиль организации прошел модерацию в Яндекс Справочнике и опубликован. Профиль организации можно привязать к объявлению, только если для него в параметре IsPublished возвращается значение YES. |
MergedIds | ArrayOfLong | Идентификаторы профилей организаций, которые объединены с основным профилем (идентификатор основного профиля указан в поле Id). Возвращаются только идентификаторы профилей, привязанных к объявлениям рекламодателя, и только если в запросе отсутствовал SelectionCriteria. |
Rubric | string | Род деятельности организации. |
Urls | ArrayOfString | Ссылки на сайт и социальные сети. |
HasOffice | YesNoEnum | Признак того, что организация имеет фактический адрес. |