Feed de pontos de interesse (PDI)

Nesta página, detalhamos as especificações técnicas do feed de ponto de interesse (PDI). Ele inclui um resumo dos campos obrigatórios, definições abrangentes de esquema e uma amostra JSON para orientar a implementação.

Especificações de feed

Esta seção descreve os requisitos e as definições do feed de PDI.

Requisitos de campo

Nome do campo Requisito Descrição
poi_id Obrigatório Uma string gerada pelo parceiro que identifica um ponto de interesse (propriedade).
nome Obrigatório O nome do PDI. Esse nome será usado como o nome de exibição da propriedade na unidade do agregador.
telefone Opcional O número de telefone de contato do PDI, incluindo os códigos de país e de área, por exemplo, +14567891234.
url Opcional O URL do site público do PDI. Observação: isso será usado apenas para fins de correspondência, não para exibição.
local Obrigatório (endereço)
Opcional (latitude/longitude)
A localização do PDI.
Obrigatório: o endereço e os campos acompanhantes são necessários para corresponder corretamente à propriedade.
Recomendado: a latitude e a longitude. Se fornecidas, o Google vai usar a latitude/longitude na exibição dos pins de propriedade no mapa da sua unidade agregadora.
imagens Obrigatório (uma imagem)
Opcional (várias)
Imagens do PDI. As imagens são importantes na exibição de propriedades. Recomendamos adicionar pelo menos uma imagem. Você pode fornecer até cinco imagens. Quando várias são fornecidas, elas são usadas na ordem em que foram enviadas (no caso de uma imagem inutilizável).

As imagens serão revisadas para garantir que não violem as políticas de pesquisa segura do Google.
classificação Recomendado Classificação média da propriedade.
num_ratings Recomendado O número de avaliações que contribuíram para o campo rating.
rating_scale Opcional A escala de classificação usada para o campo rating. Se a classificação máxima for 5, a escala de classificação será 5.
categoria Opcional Representa a categoria da propriedade.
hotel_data Opcional Campos específicos do hotel. Consulte Definição de HotelData para mais detalhes.
hotel_star_class Recomendado O valor oficial da classificação do hotel por estrelas. Esse valor precisa ser um número inteiro entre 0 e 5. Se o sistema usar valores de meia estrela ou decimais (por exemplo, 3.5), arredonde para um número inteiro (3). Forneça um valor de 0 se a classificação por estrelas não estiver disponível, for desconhecida ou não especificada. Quando definido como 0, nenhuma classificação por estrelas de hotel será mostrada na interface para os usuários.
brand_ids Opcional As marcas que podem mostrar este hotel. Se esse campo estiver vazio, o hotel poderá ser mostrado em qualquer uma das marcas associadas ao feed.
descrição Opcional Uma descrição detalhada da propriedade.
display_address Opcional O endereço exibido na interface.

Diretrizes de imagens

Todas as imagens adicionadas ao feed precisam seguir estas diretrizes:

  • Formato: precisa ser JPEG, PNG ou WebP.
  • Tamanho máximo do arquivo: menos de 30 MB por imagem.
  • Dimensões máximas: menos de 75 megapixels no total (largura x altura < 75.000.000).
  • Tipo de URL: caminho direto para o recurso de imagem (por exemplo, termina em .jpg).
  • Permissões: confira se o servidor de hospedagem permite o acesso ao Googlebot ou aos rastreadores e se não há um arquivo robots.txt bloqueando os diretórios de imagens.

Suporte multilíngue

O feed de pontos de interesse permite fornecer conteúdo localizado para campos específicos. Os campos a seguir são do tipo Text e aceitam localização:

  • name
  • description
  • display_address

Para fornecer conteúdo em vários idiomas, especifique um default_locale no campo e forneça as strings localizadas na lista localizations. Forneça todas as localizações de uma propriedade em uma única entrada de PDI. Não divida uma única propriedade entre vários arquivos JSON de idiomas.

Exemplo:

"name": {
  "localizations": [
    {
      "locale": "en",
      "text": "Banana Hotel"
    },
    {
      "locale": "es",
      "text": "Hotel Plátano"
    }
  ],
  "default_locale": "en"
}

Diretrizes de empacotamento de arquivos

Para garantir uma ingestão bem-sucedida, siga os requisitos de pacote a seguir:

  • Arquivo JSON agregado único (obrigatório): combine todos os registros de propriedade em um único arquivo JSON. Recomendamos compactar em um único arquivo GZIP e fazer upload.
  • Aviso de antipadrão: não use um arquivo por propriedade nem vários arquivos separados por país no mesmo arquivo. Essa abordagem não é aceita e vai causar falhas na extração.

Definições

Definição de 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;
}

Definição de 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 {

    UNKNOWN_CATEGORY = 0;
    HOTEL = 1;

    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 {
    // Hotel specific fields.
    HotelData hotel_data = 10;


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

}

Definição de 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;
}

Definição de 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;

  }
}

Definição de 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;
}

Definição de imagem

// 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;
}

Definição de HotelData

// Hotel specific feed data.
message HotelData {
  // The official hotel class star value.
  // Can be used in a label like "5-star hotel."
  // This value is expected to be an integer between 0 and 5. A rating of 0
  // should be used if a rating is unavailable or not specified. When
  // set to 0, no star class will be displayed on the UI for users.
  int32 hotel_star_class = 1;

  // The brands that can display this hotel.
  // If this field is empty, the hotel can be displayed under any of the
  // brands associated with the feed.
  repeated string brand_ids = 2 [(datapol.semantic_type) = ST_PARTNER_ID];
}

Amostras

Feed de pontos de interesse

Nome do arquivo: poi_1707240000.json

{
  "data": [
    {
      "poi_id": "hotel_banana",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Banana Hotel"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+16195550100",
      "url": "https://www.example-banana-hotel.com",
      "location": {
        "latitude": 32.7157,
        "longitude": -117.1611,
        "address": {
          "country": "US",
          "locality": "San Diego",
          "region": "CA",
          "postal_code": "92101",
          "street_address": "2845 W 7th St"
        }
      },
      "images": [
        {
          "url": "https://www.example.com/banana_hotel.jpg",
          "alt_text": {
             "localizations": [
               { "locale": "en", "text": "Banana Hotel Exterior" }
             ]
          }
        }
      ],
      "rating": 4.5,
      "category": "HOTEL",
      "hotel_data": {
        "hotel_star_class": 4,
        "brand_ids": ["brand_a", "brand_b"]
      }
    },
    {
      "poi_id": "hotel_kiwi",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Kiwi Hotel"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+41445550100",
      "url": "https://www.example-kiwi-hotel.com",
      "location": {
        "latitude": 47.3769,
        "longitude": 8.5417,
        "address": {
          "country": "CH",
          "locality": "Zurich",
          "postal_code": "8001",
          "street_address": "Bahnhofstrasse 10"
        }
      },
      "images": [
        {
          "url": "https://www.example.com/kiwi_hotel.jpg",
          "alt_text": {
             "localizations": [
               { "locale": "en", "text": "Kiwi Hotel Lobby" }
             ]
          }
        }
      ],
      "rating": 4.0,
      "category": "HOTEL",
      "hotel_data": {
        "hotel_star_class": 3,
        "brand_ids": ["brand_c"]
      }
    },
    {
      "poi_id": "hotel_croissant",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Croissant Hotel"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+41445550200",
      "url": "https://www.example-croissant-hotel.com",
      "location": {
        "latitude": 47.3686,
        "longitude": 8.5392,
        "address": {
          "country": "CH",
          "locality": "Zurich",
          "postal_code": "8002",
          "street_address": "Paradeplatz 1"
        }
      },
      "images": [
        {
          "url": "https://www.example.com/croissant_hotel.jpg",
          "alt_text": {
             "localizations": [
               { "locale": "en", "text": "Croissant Hotel View" }
             ]
          }
        }
      ],
      "rating": 5.0,
      "category": "HOTEL",
      "hotel_data": {
        "hotel_star_class": 5
      }
    },
    {
      "poi_id": "hotel_tiburon",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Hotel Tiburon"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+15105550100",
      "url": "https://www.example-tiburon-hotel.com",
      "location": {
        "latitude": 37.7652,
        "longitude": -122.2416,
        "address": {
          "country": "US",
          "locality": "Alameda",
          "region": "CA",
          "postal_code": "94501",
          "street_address": "1100 Atlantic Ave"
        }
      },
      "images": [
        {
          "url": "https://www.example.com/tiburon_hotel.jpg",
          "alt_text": {
             "localizations": [
               { "locale": "en", "text": "Hotel Tiburon Pool" }
             ]
          }
        }
      ],
      "rating": 4.2,
      "category": "HOTEL",
      "hotel_data": {
        "hotel_star_class": 5,
        "brand_ids": ["brand_a"]
      }
    }
  ]
}

Feed de PDI multilíngue

Nome do arquivo: poi_multilingual.json

{
  "data": [
    {
      "poi_id": "hotel_banana_multilingual",
      "name": {
        "localizations": [
          {
            "locale": "en",
            "text": "Banana Hotel"
          },
          {
            "locale": "es",
            "text": "Hotel Plátano"
          },
          {
            "locale": "fr",
            "text": "Hôtel Banane"
          }
        ],
        "default_locale": "en"
      },
      "description": {
        "localizations": [
          {
            "locale": "en",
            "text": "A beautiful hotel shaped like a banana."
          },
          {
            "locale": "es",
            "text": "Un hermoso hotel con forma de plátano."
          },
          {
            "locale": "fr",
            "text": "Un bel hôtel en forme de banane."
          }
        ],
        "default_locale": "en"
      },
      "display_address": {
        "localizations": [
          {
            "locale": "en",
            "text": "123 Banana Way, Fruit City, CA 90000"
          },
          {
            "locale": "es",
            "text": "123 Vía Plátano, Ciudad Fruta, CA 90000"
          }
        ],
        "default_locale": "en"
      },
      "telephone": "+16195550100",
      "url": "https://www.example-banana-hotel.com",
      "location": {
        "latitude": 32.7157,
        "longitude": -117.1611,
        "address": {
          "country": "US",
          "locality": "Fruit City",
          "region": "CA",
          "postal_code": "90000",
          "street_address": "123 Banana Way"
        }
      },
      "images": [
        {
          "url": "https://www.example.com/banana_hotel.jpg",
          "alt_text": {
             "localizations": [
               { "locale": "en", "text": "Banana Hotel Exterior" },
               { "locale": "es", "text": "Exterior del Hotel Plátano" }
             ]
          }
        }
      ],
      "rating": 4.5,
      "category": "HOTEL",
      "hotel_data": {
        "hotel_star_class": 4,
        "brand_ids": ["brand_mango", "brand_apricot"]
      }
    }
  ]
}