Фид объектов инфраструктуры

Как создать и загрузить фид объектов инфраструктуры

При создании и загрузке фидов объектов инфраструктуры следуйте этим инструкциям:

  • Для файлов с данными об объектах инфраструктуры следуйте спецификации, описанной в статье Фид объектов инфраструктуры. Рекомендуем использовать уникальные названия файлов данных POI для каждой загрузки. Включите в название файла временную метку, например POI_1633621547.json.
  • Загружайте фиды на локальный SFTP-сервер объектов инфраструктуры ежедневно в виде полного обновления.
  • Сведения о сервере SFTP можно найти в разделе Конфигурация > Фиды на Партнерском портале.

Выбор серверов фидов

  • Статус загрузки фида можно посмотреть в разделе Загрузка > История на Партнерском портале.

Требования к упаковке файлов

Чтобы прием контента прошел успешно, соблюдайте следующие требования к упаковке:

  • Единый агрегированный архив JSON (обязательно). Объедините все записи об объектах в один файл JSON. Рекомендуем сжать его в один архив GZIP и загрузить.
  • Предупреждение о нарушении шаблона. Не используйте один файл для каждой организации или несколько файлов, разделенных по странам, в одном архиве. Такой подход не поддерживается и приведет к сбоям при извлечении.

Поддержка нескольких языков

Фид объектов интереса поддерживает локализованный контент для определенных полей. Следующие поля имеют тип Text и поддерживают локализацию:

  • name
  • description
  • display_address

Чтобы предоставить контент на нескольких языках, укажите default_locale в поле и добавьте локализованные строки в список localizations. Укажите все локализации для объекта в одной записи POI. Не разделяйте один объект между несколькими JSON-файлами на разных языках.

Пример:

"name": {
  "localizations": [
    {
      "locale": "en",
      "text": "Tasty Bites Test Restaurant"
    },
    {
      "locale": "es",
      "text": "Restaurante de prueba Tasty Bites"
    }
  ],
  "default_locale": "en"
}

Требования к изображениям

  • Формат: JPEG, PNG или WebP.
  • Максимальный размер файла: до 30 МБ на изображение.
  • Максимальные размеры: менее 75 мегапикселей (ширина x высота < 75 000 000).
  • Тип URL: прямой путь к объекту изображения (например, заканчивается на .jpg).
  • Разрешения. Убедитесь, что сервер хостинга разрешает доступ роботам Googlebot или поисковым роботам и что файл robots.txt не блокирует каталоги изображений.
  • Безопасный поиск. Изображения должны соответствовать правилам Безопасного поиска.

Спецификация фида

Требования к полям

VssPoi

Представляет один объект инфраструктуры, например гостиницу или ресторан.

Название поляТипТребованияОписание
poi_idstring

Обязательно

Обязательно. Строка, созданная партнером и идентифицирующая объект инфраструктуры.
nameobject
(Text)

Обязательно

Обязательно. Название объекта инфраструктуры.
telephonestring

Контактный номер телефона POI, включая код страны и код региона, например +14567891234.
urlstring

URL общедоступного сайта объекта инфраструктуры. Примечание. Это значение будет использоваться только для сопоставления, а не для показа.
locationobject
(GeoCoordinates)

Обязательно

Обязательно. Местоположение объекта.
display_addressobject
(Text)

Адрес, который показывается в интерфейсе.
imagesМассив объектов
(Image)

Изображения объекта. Максимальное количество изображений – 5.
ratingчисло

Средняя оценка POI.
num_ratingsчисло

Количество оценок, на основе которых вычисляется значение поля rating.
rating_scaleчисло

Оценочная шкала, используемая для поля rating. Если максимальная оценка равна 5, то rating_scale также будет равен 5.
categoryenum
(Category)

Обязательно

Обязательно. Категория объекта инфраструктуры.
descriptionobject
(Text)

Описание достопримечательности.
oneOf
(additional_data)

Обязательно

Можно задать только одно из полей в этом разделе.

Текст

Представляет текст с локализациями.

Название поляТипТребованияОписание
localizationsМассив объектов
(LocalizedString)

Локализованные строки.
default_localestring

Региональные настройки, которые будут использоваться в качестве языка по умолчанию. Они должны быть указаны в локализациях.

LocalizedString

Представляет локализованную строку.

Название поляТипТребованияОписание
localestring

Тег языка текста, например "ru", "ru-RU" или "sr-Latn".
textstring

Текст на указанном языке.

GeoCoordinates

Геоданные места, в том числе широта, долгота и адрес.

Название поляТипТребованияОписание
latitudeчисло

[-90, +90] градусов (включительно). Обязательно, если задана долгота. В остальных случаях желательно.
longitudeчисло

от -180 до +180 градусов включительно. Обязательно, если указана широта. В остальных случаях – желательно.
oneOf
(addresses)

Обязательно

Можно задать только одно из полей в этом oneOf.

PostalAddress

Почтовый адрес местоположения.

Название поляТипТребованияОписание
countrystring

Обязательно

Обязательно. Страна, указанная с помощью кода ISO 3166-1 alpha-2, например "US".
localitystring

Обязательно

Обязательно. Населенный пункт, например "Маунтин-Вью".
regionstring

Регион, область или штат, например "CA". Это поле обязательно только в странах, где регион обычно указывается в адресе. (необязательно)
postal_codestring

Обязательно

Обязательно. Почтовый индекс: "94043"
street_addressstring

Обязательно

Обязательно. Почтовый адрес, например "Амфитеатр Парквей, 1600"

Изображение

Изображение объекта инфраструктуры.

Название поляТипТребованияОписание
urlstring

URL изображения. Google просканирует медиаконтент, размещенный по этому URL. Максимальная длина: 2000 символов.
alt_textobject
(Text)

Альтернативный текст, который будет использоваться для специальных возможностей.

HotelData

Данные фида для гостиниц.

Название поляТипТребованияОписание
hotel_star_classчисло

Официальный рейтинг отеля в звездах. Можно использовать в ярлыке, например "5-звездочный отель". Значение должно быть целым числом от 1 до 5.
brand_idsМассив строк

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

LocalData

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

Название поляТипТребованияОписание
business_hoursobject
(BusinessHours)

Обычные часы работы заведения.
price_rangeobject
(PriceRange)

Диапазон цен на услуги, предлагаемые заведением.
establishment_categoryobject
(Text)

Тип заведения.
brand_landing_pagesМассив объектов
(BrandLandingPages)

Целевые страницы бренда.

BusinessHours

Представляет периоды времени, когда компания открыта. Содержит коллекцию экземпляров [TimeRange][madden.vss_poi_feed.TimeRange]. Пример. Открыто по субботам с 09:00 до 12:00 и с 13:00 до 17:00: time_ranges { open_day: SATURDAY open_time: { hours: 9, minutes: 0 } close_day: SATURDAY close_time: { hours: 12, minutes: 0 } } time_rages { open_day: SATURDAY open_time: { hours: 13, minutes: 0 } close_day: SATURDAY close_time: { hours: 17, minutes: 0 } } Пример. Открыто по субботам с 21:00 до 02:00 воскресенья: time_ranges { open_day: SATURDAY open_time: { hours: 21, minutes: 0 } close_day: SUNDAY close_time: { hours: 2, minutes: 0 } }

Название поляТипТребованияОписание
time_rangesМассив объектов
(TimeRange)

Часы работы объекта инфраструктуры. Каждый период представляет собой диапазон часов, в течение которых объект инфраструктуры открыт в течение недели.

TimeRange

Представляет собой период времени, в течение которого POI открыт. Он начинается в указанный день и время открытия и заканчивается в указанный день и время закрытия. Время закрытия должно быть позже времени открытия, например в тот же день или на следующий.

Название поляТипТребованияОписание
open_dayenum
(DayOfWeek)

День начала диапазона дат.
open_timeobject
(TimeOfDay)

Время открытия временного диапазона.
close_dayenum
(DayOfWeek)

Дата окончания диапазона дат.
close_timeobject
(TimeOfDay)

Время закрытия временного диапазона.

TimeOfDay

Название поляТипТребованияОписание
hoursчисло

Часы в 24-часовом формате. Значение должно быть больше или равно 0 и меньше или равно 23. В API может быть разрешено значение "24:00:00" для таких случаев, как время закрытия компании.
minutesчисло

Минуты часа. Значение должно быть больше или равно 0 и меньше или равно 59.
secondsчисло

Секунды в минуте. Значение должно быть больше или равно 0 и, как правило, меньше или равно 59. В API допустимо значение "60", если разрешены високосные секунды.
nanosчисло

Доли секунды в наносекундах. Значение должно быть больше или равно 0 и меньше или равно 999 999 999.

PriceRange

Диапазон цен на услуги, предлагаемые в ММ.

Название поляТипТребованияОписание
min_priceobject
(Money)

Минимальная цена услуг, предлагаемых в объекте.
max_priceobject
(Money)

Максимальная цена услуг, предлагаемых объектом инфраструктуры.

Деньги

Представляет сумму денег с указанием типа валюты.

Название поляТипТребованияОписание
currency_codestring

Трехбуквенный код валюты, определенный в стандарте ISO 4217.
unitsчисло

Целые единицы суммы. Например, если currencyCode – это "USD", то одна единица – это один доллар США.
nanosчисло

Количество нано-единиц (10^-9) суммы. Значение должно быть в диапазоне от -999 999 999 до +999 999 999 включительно. Если значение units положительное, то значение nanos должно быть положительным или нулевым. Если значение units нулевое, то значение nanos может быть положительным, отрицательным или нулевым. Если значение units отрицательное, то значение nanos должно быть отрицательным или нулевым. Например, -1,75 доллара США будет представлено как units=-1 и nanos=-750 000 000.

BrandLandingPages

Локализованные целевые страницы бренда для одного объекта инфраструктуры.

Название поляТипТребованияОписание
brand_idstring

Бренд, к которому применяется эта конфигурация.
localized_landing_pagesМассив объектов
(LocalizedLandingPage)

Локализованные целевые страницы. Значения полей url и locales должны быть уникальными для всех локализованных целевых страниц.
default_urlstring

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

LocalizedLandingPage

Локализованная целевая страница для объекта инфраструктуры.

Название поляТипТребованияОписание
urlstring

URL целевой страницы. Максимальная длина: 2000 символов.
localesМассив строк

Ограничивает доступ к этой странице для пользователей с указанными языковыми настройками. Должен содержать теги языка, например "ru", "ru-RU" или "sr-Latn".

Категория

Категория объекта инфраструктуры. Оно должно соответствовать полю additional_data, указанному ниже.

НазваниеОписание
UNKNOWN_CATEGORY
HOTEL
LOCAL

День недели

Представляет день недели.

НазваниеОписание
DAY_OF_WEEK_UNSPECIFIEDДень недели не указан.
MONDAYПонедельник
TUESDAYTuesday (вторник)
WEDNESDAYWednesday (среда)
THURSDAYThursday (четверг)
FRIDAYFriday (пятница)
SATURDAYSaturday (суббота)
SUNDAYВоскресенье

additional_data

Обязательно. Поля для определенных категорий. Оно должно совпадать со значением в поле category выше.

Название поляТипТребованияОписание
hotel_dataobject
(HotelData)

Несовместимо с local_data

Поля, относящиеся к гостиницам.
local_dataobject
(LocalData)

Несовместимо с hotel_data

Поля, относящиеся к определенной стране.

адреса

Обязательно. Адрес местоположения.

Название поляТипТребованияОписание
addressobject
(PostalAddress)

Почтовый адрес местоположения.

Определения

Определение VssPoiFeed

// Represents a Point of Interest (POI) data feed provided by a partner.
export message VssPoiFeed {
  // The POIs in the feed.
  repeated VssPoi data = 1;
}

Определение VssPoi

// Represents a single Point of Interest (POI) entity e.g. a hotel or
// restaurant.
export message VssPoi {
  // Required. A string generated by the partner that identifies a POI.
  string poi_id = 1;

  // The entity name, telephone, url and location are used to support
  // matching partner inventory with entities already present on Google.

  // Required. The name of the POI.
  Text name = 2;

  // The contact telephone number of the POI including its country and
  // area codes, e.g. +14567891234.
  string telephone = 3 [(datapol.semantic_type) = ST_PHONE_NUMBER];

  // The url of the POI's public website.
  // Note: This will be used just for matching purposes, not for display.
  string url = 4;

  // Required. The location of the POI.
  GeoCoordinates location = 5;

  // The address displayed on the UI.
  Text display_address = 17;

  // Images of the POI.
  // Max number of images: 5.
  repeated Image images = 6;

  // Average rating for the POI.
  float rating = 12;

  // The number of contributing ratings for the `rating` field.
  int64 num_ratings = 13;

  // The rating scale used for the `rating` field. If max rating is 5, then
  // rating_scale is 5.
  int32 rating_scale = 14;

  // Represents the category of the POI.
  // It should match the `additional_data` oneof field below.
  export enum Category {


    LOCAL = 4;
  }

  // Required. Represents the category of the POI.
  Category category = 9;

  // A description of the POI.
  Text description = 16;

  // Required. Category specific fields.
  // It should match the `category` field above.
  oneof additional_data {


    // Local specific fields.
    LocalData local_data = 15;
  }

}

Text: определение

// Represents a text with localizations.
message Text {
  // Represents a localized string.
  message LocalizedString {
    // The text's language tag, such as "en", "en-US" or "sr-Latn".
    string locale = 1;

    // The text in the specified locale.
    string text = 2;
  }

  // The localized strings.
  repeated LocalizedString localizations = 1;

  // The locale to use as the default language it must be present in the
  // localizations.
  string default_locale = 2;
}

Определение записи GeoCoordinates

// The Geo data of a location, including latitude, longitude, and address.
message GeoCoordinates {
  option (datapol.msg_semantic_type) = ST_LOCATION;

  // [-90, +90] degrees (inclusive).
  // Required if longitude is set, otherwise nice to have.
  double latitude = 1;

  // [-180, +180] degrees (inclusive).
  // Required if latitude is set, otherwise nice to have.
  double longitude = 2;

  // Required. Address for a location.
  oneof addresses {
    // Postal address of the location.
    PostalAddress address = 3;

  }
}

Определение записи PostalAddress

// The postal address for the location.
message PostalAddress {
  option (datapol.msg_semantic_type) = ST_LOCATION;

  // Required. The country, using ISO 3166-1 alpha-2 country code, e.g. "US".
  string country = 1;

  // Required. The locality/city, e.g. "Mountain View".
  string locality = 2;

  // The region/state/province, e.g. "CA". This field is only required in
  // countries where region is commonly a part of the address. (optional)
  string region = 3;

  // Required. The postal code, e.g. "94043".
  string postal_code = 4;

  // Required. The street address, e.g. "1600 Amphitheatre Pkwy".
  string street_address = 5;
}

Определение изображения

// Represents an image of the Point of Interest (POI).
export message Image {
  // The url of the image. Google will crawl the media hosted at this URL.
  // Max length: 2000.
  string url = 1;

  // The alternative text to be used for accessibility.
  Text alt_text = 2;
}

Определение LocalData

// Establishment specific feed data.
message LocalData {
  // The regular business hours of the establishment.
  BusinessHours business_hours = 1;

  // Price range of the services offered by the establishment.
  PriceRange price_range = 2;

  // The type of establishment.
  Text establishment_category = 3;

  // Required. The brand landing pages. At least one must be provided.
  repeated BrandLandingPages brand_landing_pages = 4;
}

BrandLandingPages Definition

// The Localized brand landing pages for a single Point of Interest (POI).
message BrandLandingPages {
  // Required. The brand this configuration applies to.
  string brand_id = 1 [(datapol.semantic_type) = ST_PARTNER_ID];

  // Localized landing page for the Point of Interest (POI).
  message LocalizedLandingPage {

    // The url of the landing page.
    // Max length: 2000.
    string url = 1;

    // Restricts this page to users with the specified language preference.
    // Must contain language tags, such as "en", "en-US" or "sr-Latn".
    repeated string locales = 3;
  }

  // The localized landing pages.
  // The url and locales fields values must be unique across all the localized
  // landing pages.
  repeated LocalizedLandingPage localized_landing_pages = 2;

  // Required. The default landing page url to be used when none of the
  // localized landing pages matches the user's language.
  string default_url = 3;
}

Примеры

Фид объектов инфраструктуры

Название файла: poi_1707240000.json

{
  "data": [
    {
      "poi_id": "test_restaurant_1",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Tasty Bites Test Restaurant"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+1234567890",
      "url": "https://www.tastybitestest.com",
      "location": {
        "latitude": 37.422,
        "longitude": -122.084,
        "address": {
          "country": "US",
          "locality": "Mountain View",
          "postal_code": "94043",
          "street_address": "1600 Amphitheatre Pkwy"
        }
      },
      "display_address": {
        "localizations": [
          {
            "locale": "en",
            "text": "1600 Amphitheatre Pkwy, Mountain View, CA 94043"
          }
        ],
        "default_locale": "en"
      },
      "images": [
        {
          "url": "https://www.tastybitestest.com/images/interior.jpg",
          "alt_text": {
            "localizations": [
              {
                "locale": "en",
                "text": "Cozy dining area of Tasty Bites"
              }
            ],
            "default_locale": "en"
          }
        }
      ],
      "rating": 4.7,
      "num_ratings": 150,
      "rating_scale": 5,
      "category": "LOCAL",
      "description": {
        "localizations": [
          {
            "locale": "en",
            "text": "A mock restaurant for testing the POI feed ingestion."
          }
        ],
        "default_locale": "en"
      },
      "local_data": {
        "establishment_category": {
           "localizations": [
             {
               "locale": "en",
               "text": "Restaurant"
             }
           ],
           "default_locale": "en"
        },
        "price_range": {
          "min_price": {
            "currency_code": "USD",
            "units": 15,
            "nanos": 0
          },
          "max_price": {
            "currency_code": "USD",
            "units": 45,
            "nanos": 0
          }
        },
        "business_hours": {
          "time_ranges": [
            {
              "open_day": "MONDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "MONDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "TUESDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "TUESDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "WEDNESDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "WEDNESDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "THURSDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "THURSDAY",
              "close_time": { "hours": 22, "minutes": 0 }
            },
            {
              "open_day": "FRIDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "FRIDAY",
              "close_time": { "hours": 23, "minutes": 0 }
            },
            {
              "open_day": "SATURDAY",
              "open_time": { "hours": 10, "minutes": 0 },
              "close_day": "SATURDAY",
              "close_time": { "hours": 23, "minutes": 0 }
            },
            {
              "open_day": "SUNDAY",
              "open_time": { "hours": 10, "minutes": 0 },
              "close_day": "SUNDAY",
              "close_time": { "hours": 20, "minutes": 0 }
            }
          ]
        },
        "brand_landing_pages": [
          {
            "brand_id": "tasty_bites_brand",
            "localized_landing_pages": [
              {
                "url": "https://www.tastybitestest.com/en",
                "locales": ["en-US", "en-GB"]
              }
            ],
            "default_url": "https://www.tastybitestest.com"
          }
        ]
      }
    }
  ]
}

Многоязычный фид объектов инфраструктуры

Название файла: poi_multilingual.json.

{
  "data": [
    {
      "poi_id": "test_restaurant_1",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Tasty Bites Test Restaurant"
          },
          {
            "locale": "fr",
            "text": "Restaurant de test Tasty Bites"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+1234567890",
      "url": "https://www.tastybitestest.com",
      "location": {
        "latitude": 37.422,
        "longitude": -122.084,
        "address": {
          "country": "US",
          "locality": "Mountain View",
          "postal_code": "94043",
          "street_address": "1600 Amphitheatre Pkwy"
        }
      },
      "display_address": {
        "localizations": [
          {
            "locale": "en",
            "text": "1600 Amphitheatre Pkwy, Mountain View, CA 94043"
          },
          {
            "locale": "fr",
            "text": "1600 Amphitheatre Pkwy, Mountain View, CA 94043"
          }
        ],
        "default_locale": "en"
      },
      "images": [
        {
          "url": "https://www.tastybitestest.com/images/interior.jpg",
          "alt_text": {
            "localizations": [
              {
                "locale": "en",
                "text": "Cozy dining area of Tasty Bites"
              },
              {
                "locale": "fr",
                "text": "Espace salle à manger accueillant de Tasty Bites"
              }
            ],
            "default_locale": "en"
          }
        }
      ],
      "rating": 4.7,
      "num_ratings": 150,
      "rating_scale": 5,
      "category": "LOCAL",
      "description": {
        "localizations": [
          {
            "locale": "en",
            "text": "A mock restaurant for testing the POI feed ingestion."
          },
          {
            "locale": "fr",
            "text": "Un faux restaurant pour tester l'ingestion de flux de points d'intérêt."
          }
        ],
        "default_locale": "en"
      },
      "local_data": {
        "establishment_category": {
           "localizations": [
             {
               "locale": "en",
               "text": "Restaurant"
             },
             {
               "locale": "fr",
               "text": "Restaurant"
             }
           ],
           "default_locale": "en"
        },
        "price_range": {
          "min_price": {
            "currency_code": "USD",
            "units": 15,
            "nanos": 0
          },
          "max_price": {
            "currency_code": "USD",
            "units": 45,
            "nanos": 0
          }
        },
        "business_hours": {
          "time_ranges": [
            {
              "open_day": "MONDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "MONDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "TUESDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "TUESDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "WEDNESDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "WEDNESDAY",
              "close_time": { "hours": 21, "minutes": 0 }
            },
            {
              "open_day": "THURSDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "THURSDAY",
              "close_time": { "hours": 22, "minutes": 0 }
            },
            {
              "open_day": "FRIDAY",
              "open_time": { "hours": 11, "minutes": 0 },
              "close_day": "FRIDAY",
              "close_time": { "hours": 23, "minutes": 0 }
            },
            {
              "open_day": "SATURDAY",
              "open_time": { "hours": 10, "minutes": 0 },
              "close_day": "SATURDAY",
              "close_time": { "hours": 23, "minutes": 0 }
            },
            {
              "open_day": "SUNDAY",
              "open_time": { "hours": 10, "minutes": 0 },
              "close_day": "SUNDAY",
              "close_time": { "hours": 20, "minutes": 0 }
            }
          ]
        },
        "brand_landing_pages": [
          {
            "brand_id": "tasty_bites_brand",
            "localized_landing_pages": [
              {
                "url": "https://www.tastybitestest.com/fr",
                "locales": ["fr-FR", "fr-CA"]
              },
              {
                "url": "https://www.tastybitestest.com/en",
                "locales": ["en-US", "en-GB"]
              }
            ],
            "default_url": "https://www.tastybitestest.com"
          }
        ]
      }
    }
  ]
}