Description of the elements processed by Yandex
Mandatory elements
To be processed correctly by Yandex, the organization card must strictly conform to the hCard format. In particular, the card's root element must be a vcard
class element. Other elements (called properties) must be located inside the root.
For information about which HTML code fragments are acceptable as property values, see the Markup processing rules section.
In addition, to be loaded in the Yandex.Business database, the organization card must contain the following properties:
fn and org
Organization name.
According to the hCard standard, organization cards must have the fn
and org
properties set to the same values. We recommended that you mark the organization name with two classes in the same element:
<span class="fn org">...</span>
adr
Organization's address.
The address should be detailed enough to find the organization on the map. Cards are processed only for four countries: Russia, Ukraine, Belarus, and Kazakhstan.
For the adr
class element, the following nested properties are processed (each of them can be specified more than once):
country-name
— Country.region
— Sub-federal region plus area.locality
— City, town or village.street-address
— Street, house, building, and so on (address down to the building).extended-address
— Staircase, floor, office, and so on (information about location inside the building), shopping or business center, as well as any description not included in the address.postal-code
— Postal code.
For the address to be recognized correctly, you need to specify the city, town or village (the locality
property). If the city, town or village name isn't unique (for example, Oakville), you have to specify the region (the region
property).
We recommend that you mark up only actual addresses (by which people can find you) and not legal addresses.
A card can contain multiple addresses. This may be useful if the organization has several branches with the same names and the same contact information (common site, call center, and so on). If the branches have different names, phone numbers, or email addresses, we recommend that you create a separate card (the vcard
class element) for each branch.
tel
The phone number (with the city code).
Preferred format: +{country code} ({city code}) {number}. For example: +7 (890) 123-45-67, +375 (12) 345-67-89. If you need to display the phone number to users in a different format, you can use the <abbr>
element.
You can specify several phone numbers in one card.
Example:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div class="tel">Telephone:
<abbr class="value" title="+ 7 (890) 123-45-67">123-45-67</abbr>
</div>
<div class="tel">
<abbr class="type" title="fax">Fax:</abbr>
<abbr class="value" title="+ 7 (890) 123-45-89">123-45-89</abbr>
</div>
</div>
Examples of cards that contain the minimal required information
<div class="vcard">
<div>Chamomile <span class="fn org">Cafe</span></div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div class="tel">Telephone:
<abbr class="value" title="+ 7 (890) 123-45-67">123-45-67</abbr>
</div>
</div>
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="postal-code">111222</span>,
<span class="country-name">Russia</span>,
<span class="region">Apricot region</span>,
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>,
<span class="extended-address">floor 7, suite 701</span>
<div class="tel">Telephone:
<abbr class="value" title="+ 7 (890) 123-45-67">123-45-67</abbr>
</div>
</div>
</div>
Supported elements
In addition to the required fn
and org
, adr
andtel
properties, Yandex handles the following properties:
We recommend that you specify as many of these properties as possible. This will allow Yandex to show users as much information as possible about your company.
category
Organization's business category.
This property helps to assign the organization to a category in Yandex.Business and speed up the organization card processing by the service. If it is acceptable to specify the organization's business category in the contact information block, set it in the category
property.
You can specify multiple categories in one card, for example:
<div class="vcard">
<div>
<span class="category">Cafe</span>-<span class="category">deli</span>
<span class="fn org">Chamomile</span>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<span class="url">
<span class="value-title" title="http://www.cafe.com"> </span>
</span>
</div>
You can also add a category
property that is invisible for the site users. For example, you can use a nested element of the value-title
class with the title
attribute:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic |||UNTRANSLATED_CONTENT_START|||Романтиков, д. 21</span>
</div>
<span class="category">
<span class="value-title" title="кафе"> </span>
</span>
</div>|||UNTRANSLATED_CONTENT_END|||
For information about which HTML code fragments are acceptable as property values, see the Markup processing rules section.
Email address.
You can specify several email addresses in one card.
An email address can be displayed as plain text or as a link.
Examples:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div class="email">cafe@cafe.com</div>
</div>
<div class="vcard">
<div>
<a class="fn org url" href="http://www.romashka-cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div>Email:
<a class="email" href="mailto:cafe@cafe.com">
chamomile@chamomile-cafe.com </a>
</div>
<div>Employment inquiries:
<a class="email" href="mailto:hr@cafe.com">
hr@chamomile-cafe.com </a>
</div>
<div>Purchasing inquiries:
<a class="email" href="mailto:buy@cafe.com">
buy@chamomile-cafe.com </a>
</div>
</div>
For information about which HTML code fragments are acceptable as property values, see the Markup processing rules section.
geo
Geographic coordinates of the address. Specified in degrees.
If you have this information, we recommend that you include it in the card, because it facilitates the geocoding of your location.
A card can contain only one geo
class element.
For this property, you should set the following nested properties:
latitude
— Latitude.longitude
— Longitude.
The coordinates are usually made invisible for the site users, for example by using the nested element of the value-title
class with the title
attribute:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<span class="geo">
<span class="latitude">
<span class="value-title" title="55.792188"> </span>
</span>
<span class="longitude">
<span class="value-title" title="37.764956"> </span>
</span>
</span>
</div>
If you show the coordinates on the page, it makes sense to specify them in degrees, minutes and seconds:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div class="geo">
<abbr class="latitude" title="55.792188">Latitude: 55°47′31.88″ N</abbr>
<abbr class="longitude" title="37.764956">Longitude: 37°45′53.84″ E</abbr>
</div>
</div>
For information about which HTML code fragments are acceptable as property values, see the Markup processing rules section.
url
The link to the organization's official site.
Preferably, the link should lead to the site's home page (or the branch page, if the card contains information about a branch). For example, the card is located on the http://www.romashka-cafe.ru/contacts.html page, and the url
property is set to http://www.romashka-cafe.ru.
The hCard standard allows multiple url
class elements, but only the most suitable one is chosen when you add the card to Yandex.Business.
If you included the site address in the contact details block, you can assign the url
class to the <a>
element:
<a class="url" href="...">...</a>
If your contact information doesn't contain a URL, you can make the url
property invisible to site users with the following structure:
<span class="url"><span class="value-title" title="..."> </span></span>
For information about which HTML code fragments are acceptable as property values, see the Markup processing rules section.
workhours
The organization's hours of business.
This property is not provided by the hCard standard. It is added by Yandex as an extension.
To specify the business hours, use the Yandex.Business format, for example:
Mon-Fri 9:00-18:00
Mon-Fri 9:00-18:00, lunch 13:00-14:00, Sat-Sun 10:00-17:00, lunch 13:30-14:00
Mon-Sat 11:00-20:00, Sun 12:00-24:00
daily 10:00-24:00
Round the clock
You can specify the business hours in any format.
Example:
<div class="vcard">
<div>
<a class="fn org url" href="http://www.cafe.com">Chamomile Cafe</a>
</div>
<div class="adr">
<span class="locality">Sunny city</span>,
<span class="street-address">Romantic avenue, 21</span>
</div>
<div>
We are open <span class="workhours">daily from 11:00 to 24:00</span>
</div>
</div>
Other elements
Other hCard format properties are ignored by Yandex. However, you can include them in the organization card to make the data available to other services. For example, if contact information includes the company logo, use the logo
property.
The complete list of properties can be found in the official format specification in the Property List section.