SDK Engage Travel: instruções técnicas de integração de terceiros

O Google está criando uma plataforma no dispositivo que organiza os apps dos usuários por categoria e possibilita uma nova experiência imersiva para consumo e descoberta de conteúdo personalizado de apps. Essa experiência em tela cheia oferece aos parceiros dos desenvolvedores uma oportunidade de mostrar o melhor conteúdo avançado em um canal dedicado fora do app. Este guia contém instruções para que os parceiros dos desenvolvedores integrem o conteúdo de viagens e eventos deles usando o SDK Engage para preencher essa nova área.

Detalhe de integração

Terminologia

Essa integração inclui os três tipos de cluster a seguir: recomendação, destaque e continuação.

  • Os clusters de recomendação mostram sugestões personalizadas de viagens e eventos de um parceiro de desenvolvedor específico. Essas recomendações podem ser personalizadas para o usuário ou generalizadas (por exemplo, itens em alta). Use-as para exibir recomendações de artigos, eventos, hospedagem ou lugares de interesse.

    • Um cluster de recomendação pode ser formado por listas de ArticleEntity, EventEntity, LodgingEntity, PointOfInterestEntity ou StoreEntity, mas não por uma combinação de diferentes tipos de entidade.

    As recomendações têm esta estrutura:

    • Cluster de recomendação: uma visualização de interface que contém um grupo de recomendações do mesmo parceiro do desenvolvedor.

    • Entidade: um objeto que representa um único item em um cluster. Essa integração oferece algumas entidades que seriam exibidas usando o cluster de recomendação:

      • ArticleEntity: ArticleEntity representa uma recomendação para conteúdo de texto relacionado a viagens e eventos. Ela pode ser usada em artigos, postagens de blogs, conteúdo de marketing, snippets de notícias etc.

        Figura 1:interface mostrando um único ArticleEntity no cluster de recomendações.
      • EventEntity: EventEntity representa um evento que acontecerá no futuro. O horário de início do evento é uma informação essencial que precisa ser transmitida aos usuários.

        Figura 2:interface mostrando um único EventEntity no cluster de recomendações.
      • LodgingEntity: LodgingEntity representa uma acomodação, como um hotel, apartamento ou casa de férias para aluguel de curto e longo prazo.

        Figura 3:interface mostrando uma única LodgingEntity no cluster de recomendações.
      • StoreEntity: representa uma loja, restaurante, café etc. Destaca o conteúdo em que um restaurante ou loja é a informação essencial que precisa ser transmitida aos usuários.

        Figura 4:interface mostrando uma única StoreEntity no cluster de recomendações.
      • PointOfinterestEntity: representa um local de interesse, como um posto de gasolina, local para eventos, parque temático, museu, atração turística, trilha de caminhada etc. Ele destaca conteúdos em que o local é uma informação essencial que precisa ser transmitida aos usuários. Ele não deve ser usado para hospedagem, loja ou restaurante.

        Figura 5:interface mostrando um único PointOf InterestEntity no cluster "Recomendações".
  • O cluster de continuação mostra conteúdo com que os usuários interagiram recentemente de vários parceiros de desenvolvedores em um único grupo de interfaces. Cada parceiro de desenvolvedor pode transmitir no máximo 10 entidades no cluster de continuação.

    O conteúdo de continuação pode ter esta estrutura:

    • ArticleEntity: ArticleEntity representa uma recomendação de conteúdo relacionado a viagens e eventos. Essa entidade pode ser usada para representar matérias de notícias inacabadas ou outro conteúdo que o usuário queira continuar consumindo de onde o deixou. Exemplo: trecho de notícias ou de postagem de blog sobre um destino de viagem ou um evento.

      Figura 6. IU que mostra uma única ArticleEntity em um cluster de continuação.
    • RestaurantReservaEntity: representa uma reserva em um restaurante ou café e ajuda os usuários a acompanhar reservas futuras ou em andamento.

      Figura 7. Interface que mostra uma única RestaurantReservaEntity em um cluster de continuação.
    • EventReservaEntity: representa uma reserva para um evento e ajuda os usuários a acompanhar as reservas de eventos futuros ou em andamento. Os eventos podem incluir, entre outros:

      • Eventos esportivos, como reserva para uma partida de futebol
      • Eventos de jogos, como reserva para eSports
      • Eventos de entretenimento, como reserva de filmes em cinema, show, teatro, sessão de autógrafos
      • Reservas de viagem ou de ponto de interesse, como tours guiados, ingressos de museus
      • Reservas sociais / de seminários / conferências
      • Reservas de sessões de treinamento / educação
      Figura 8. IU que mostra um único EventReservaEntity em um cluster de continuação.
    • LodgingReservaEntity: a LodgingEntityReserva representa uma reserva de hospedagem de viagens e ajuda os usuários a rastrear reservas futuras ou em andamento de hotéis ou aluguel por temporada.

      Figura 9. IU mostrando uma única LodgingReservaEntity em um cluster de continuação.
    • TransportationReservaEntity: representa a reserva de transporte por qualquer meio e ajuda os usuários a rastrear reservas de voos, balsas, trens, ônibus, viagens ou cruzeiros.

      Figura 10. Interface que mostra um único TransportationReservaEntity em um cluster de continuação.
    • VehicleRentalReservaEntity: representa a reserva de aluguel de veículos e ajuda os usuários a monitorar reservas de aluguel de veículos futuras ou em andamento.

      Figura 11. Interface mostrando um único VehicleRentalReservaEntity em um cluster de continuação.
  • O cluster de destaque é uma visualização da interface que mostra o principal GenericFeaturedEntity escolhido de vários parceiros de desenvolvedores em um único grupo de interfaces. Há um único cluster de destaque, exibido perto da parte de cima da interface, com um posicionamento prioritário acima de todos os clusters de recomendação. Cada parceiro de desenvolvedor pode transmitir uma única entidade de um tipo com suporte em "Destaque", com muitas entidades (possivelmente de tipos diferentes) de vários desenvolvedores de apps no cluster.

    • GenericDestaqueEntity: é diferente do item de recomendação, porque o item em destaque precisa ser usado para um único conteúdo principal dos desenvolvedores e precisa representar o conteúdo mais importante que será interessante e relevante para os usuários.

      Figura 12:interface mostrando um FeaturedCluster com uma lista de GenericFeaturedEntity

Pré-trabalho

Nível mínimo da API: 19

Adicione a biblioteca com.google.android.play:engage ao app:

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.4.1'
}

Resumo

O design é baseado na implementação de um serviço vinculado.

Os dados que um cliente pode publicar estão sujeitos aos seguintes limites para diferentes tipos de clusters:

Tipo de cluster Limites de cluster Limites mínimos de entidades em um cluster Limites máximos de entidades em um cluster
Clusters de recomendação No máximo 5 Pelo menos 5 No máximo 25 (ArticleEntity, EventEntity, LodgingEntity, StoreEntity ou PointOfInterestEntity)
Cluster de continuação No máximo 1 Pelo menos 1 No máximo 10 (ArticleEntity, RestaurantReservationEntity EventReservationEntity, LodgingReservationEntity, TransportationReservationEntity ou VehicleRentalReservationEntity)
Cluster de destaque No máximo 1 Pelo menos 1 No máximo 10 (GenericFeaturedEntity)

Etapa 1: fornecer dados da entidade

O SDK definiu entidades diferentes para representar cada tipo de item. Oferecemos suporte às seguintes entidades na categoria "Viagens e eventos":

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. RestaurantReservationEntity
  8. EventReservationEntity
  9. LodgingReservationEntity
  10. TransportationReservationEntity
  11. VehicleRentalReservationEntity

As tabelas abaixo descrevem os atributos e os requisitos disponíveis para cada tipo.

GenericFeaturedEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Poster images Obrigatório

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:caso um selo seja fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Título Opcional Título da entidade.

Texto livre

Tamanho de texto recomendado: 50 caracteres

Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Tratamento especial de UX em imagem/vídeo, por exemplo, como sobreposição de selos na imagem

  • Por exemplo: "Atualização em tempo real"
  • Por exemplo: Duração da leitura do artigo

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
Categorias de conteúdo Opcional Descreva a categoria do conteúdo na entidade.

Lista de tipos enumerados

Consulte a seção Categoria de conteúdo para orientação.

ArticleEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

Texto livre

Tamanho de texto recomendado: máximo de 50 caracteres

Poster images Opcional

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:é altamente recomendável usar imagens. Se um selo for fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Fonte: título Opcional O nome do autor, organização ou denunciante

Texto livre

Tamanho de texto recomendado: menos de 25 caracteres

Origem: imagem Opcional Uma imagem da fonte, como o autor, a organização, o repórter Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Tratamento especial de UX em imagem/vídeo, por exemplo, como sobreposição de selos na imagem

  • Por exemplo: "Atualização em tempo real"
  • Por exemplo: Duração da leitura do artigo

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
Horário de publicação do conteúdo Opcional É o carimbo de data/hora da época em milissegundos em que o conteúdo foi publicado / atualizado no app. Carimbo de data/hora da época em milissegundos
Last Engagement Time Obrigatório sob certas condições

O carimbo de data/hora da época em milissegundos em que o usuário interagiu com essa entidade pela última vez.

Observação:esse campo será obrigatório se essa entidade fizer parte do cluster de continuação.

Carimbo de data/hora da época em milissegundos
Porcentagem do progresso Obrigatório sob certas condições

A porcentagem de todo o conteúdo consumido pelo usuário até o momento.

Observação:esse campo será obrigatório se essa entidade fizer parte do cluster de continuação.

Um valor int entre 0 e 100, inclusive.
Categorias de conteúdo Opcional Descreva a categoria do conteúdo na entidade.

Lista de tipos enumerados

Consulte a seção Categoria de conteúdo para orientação.

EventEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

String

Tamanho de texto recomendado: máximo de 50 caracteres

Horário de início Obrigatório

O carimbo de data/hora da época em que o evento deveria começar.

Observação:isso será representado em milissegundos.

Carimbo de data/hora da época em milissegundos
Modo de evento Obrigatório

Um campo para indicar se o evento será virtual, presencial ou ambos.

Enumeração: VIRTUAL, IN_PERSON ou HYBRID
Poster images Obrigatório

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:é altamente recomendável usar imagens. Se um selo for fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Local – país Obrigatório sob certas condições

O país em que o evento acontecerá.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório sob certas condições

A cidade em que o evento vai acontecer.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório sob certas condições

O endereço ou nome do local onde o evento ocorrerá e que deve ser exibido ao usuário.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do local onde o evento será realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que o evento está sendo realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do local em que o evento está sendo realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional O bairro (se aplicável) onde o evento será realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Horário de término Opcional

O carimbo de data/hora da época em que o evento deveria terminar.

Observação:isso será representado em milissegundos.

Carimbo de data/hora da época em milissegundos
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual do ingresso/passe para o evento.

Precisa ser fornecido se o preço tachado for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original do ingresso/passe para o evento. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Categorias de conteúdo Opcional Descreva a categoria do conteúdo na entidade.

Lista de tipos enumerados qualificados

  • TYPE_FILTERS_AND_TV_SHOWS (por exemplo, cinema)
  • TYPE_DIGITAL_GAMES (por exemplo, eSports)
  • TYPE_MUSIC (por exemplo, show)
  • TYPE_TRAVEL_AND_LOCAL (por exemplo, Tour, festival)
  • TYPE_HEALTH_AND_FITENESS (Por exemplo, aula de ioga)
  • TYPE_EDUCATION (por exemplo, turma)
  • TYPE_SPORTS (por exemplo, futebol americano)
  • TYPE_DATING (por exemplo, encontro)

Consulte a seção Categoria de conteúdo para orientação.

LodgingEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

String

Tamanho de texto recomendado: máximo de 50 caracteres

Poster images Obrigatório

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:caso um selo seja fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Local – país Obrigatório O país em que a hospedagem está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório A cidade em que o hotel está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório O endereço da hospedagem que será exibido ao usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do estabelecimento.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que a hospedagem está localizada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do hotel.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional O bairro (se aplicável) do hotel.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

DisponibilidadeWindow - Horário de início Opcional Carimbo de data/hora da época em milissegundos em que se espera que o hotel esteja aberto/disponível. Carimbo de data/hora da época em milissegundos
Janela de disponibilidade: horário de término Opcional Carimbo de data/hora da época em milissegundos até que o hospedagem esteja aberto/disponível. Carimbo de data/hora da época em milissegundos
Classificação: valor máximo Opcional

O valor máximo da escala de avaliação.

Precisa ser fornecido se o valor atual da classificação também for informado.

Número maior ou igual a 0,0
Classificação – Valor atual Opcional

O valor atual da escala de classificação.

Precisa ser fornecido se o valor máximo de avaliação também for fornecido.

Número maior ou igual a 0,0
Classificação: quantidade Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se o app quiser controlar como isso é exibido para os usuários. Forneça a string concisa que possa ser exibida para o usuário. Por exemplo, se a contagem for 1.000.000, use abreviações como 1 milhão para não aparecer truncada em telas menores.

String
Classificação: valor da contagem Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se você não quiser processar a lógica de abreviação de exibição por conta própria. Quando "Count" e "Count Value" estão presentes, ele é usado para mostrar aos usuários

Longa
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual da hospedagem.

Precisa ser fornecido se o preço promocional for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original da hospedagem, que aparece com desconto na interface. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

StoreEntity

O objeto StoreEntity representa uma loja individual que os parceiros de desenvolvedores querem publicar, como um restaurante ou mercado.

Atributo Requisito Descrição Formato
Poster images Obrigatório É necessário fornecer pelo menos uma imagem. Consulte as orientações em Especificações de imagem.
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Opcional O nome da loja.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Localização Opcional A localização da loja.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Callout Opcional Frase de destaque para apresentar uma promoção, evento ou atualização para a loja, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Callout fine print Opcional Texto com os termos da frase de destaque.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Descrição Opcional Uma descrição da loja.

Texto livre

Tamanho de texto recomendado: menos de 90 caracteres (um texto muito longo será mostrado com reticências)

Classificação: valor máximo Opcional

O valor máximo da escala de avaliação.

Precisa ser fornecido se o valor atual da classificação também for informado.

Número maior ou igual a 0,0
Classificação – Valor atual Opcional

O valor atual da escala de classificação.

Precisa ser fornecido se o valor máximo de avaliação também for fornecido.

Número maior ou igual a 0,0
Classificação: quantidade Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se o app quiser controlar como isso é exibido para os usuários. Forneça a string concisa que possa ser exibida para o usuário. Por exemplo, se a contagem for 1.000.000, use abreviações como 1 milhão para não aparecer truncada em telas menores.

String
Classificação: valor da contagem Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se você não quiser processar a lógica de abreviação de exibição por conta própria. Quando "Count" e "Count Value" estão presentes, ele é usado para mostrar aos usuários

Longa

PointOfInterestEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

String

Tamanho de texto recomendado: máximo de 50 caracteres

Poster images Obrigatório

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:é altamente recomendável usar imagens. Se um selo for fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Local – país Obrigatório O país em que o ponto de interesse está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório A cidade em que o ponto de interesse está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório O endereço do ponto de interesse que será exibido para o usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do ponto de interesse.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que o ponto de interesse está localizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do ponto de interesse.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional A vizinhança (se aplicável) do ponto de interesse.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

DisponibilidadeWindow - Horário de início Opcional Carimbo de data/hora da época em milissegundos em que o ponto de interesse está aberto/disponível. Carimbo de data/hora da época em milissegundos
Janela de disponibilidade: horário de término Opcional Carimbo de data/hora da época em milissegundos até que o ponto de interesse esteja aberto/disponível. Carimbo de data/hora da época em milissegundos
Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Classificação: valor máximo Opcional

O valor máximo da escala de avaliação.

Precisa ser fornecido se o valor atual da classificação também for informado.

Número maior ou igual a 0,0
Classificação – Valor atual Opcional

O valor atual da escala de classificação.

Precisa ser fornecido se o valor máximo de avaliação também for fornecido.

Número maior ou igual a 0,0
Classificação: quantidade Opcional

A contagem de classificações do ponto de interesse.

Observação:forneça esse campo se o app quiser controlar como isso é exibido para os usuários. Forneça a string concisa que possa ser exibida para o usuário. Por exemplo, se a contagem for 1.000.000, use abreviações como 1 milhão para não aparecer truncada em telas menores.

String
Classificação: valor da contagem Opcional

A contagem de classificações do ponto de interesse.

Observação:forneça esse campo se você não quiser processar a lógica de abreviação de exibição por conta própria. Quando "Count" e "Count Value" estão presentes, ele é usado para mostrar aos usuários

Longa
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual dos ingressos/passagens do ponto de interesse.

Precisa ser fornecido se o preço tachado for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original dos ingressos/passagens do ponto de interesse. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Categorias de conteúdo Opcional Descreva a categoria do conteúdo na entidade.

Lista de tipos enumerados qualificados

  • TIPO_TRAVEL_AND_LOCAL
  • TYPE_FILTERS_AND_TV_SHOWS (por exemplo, cinema)
  • TYPE_MEDICAL (por exemplo, hospital)
  • TYPE_EDUCATION (por exemplo, escola)
  • TYPE_SPORTS (por exemplo, estádio)

Consulte a seção Categoria de conteúdo para orientação.

RestaurantReservationEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

String

Tamanho de texto recomendado: máximo de 50 caracteres

Horário de início da reserva Obrigatório Carimbo de data/hora da época em milissegundos em que a reserva deve começar. Carimbo de data/hora da época em milissegundos
Local – país Obrigatório O país em que o restaurante está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório A cidade em que o restaurante está acontecendo.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório O endereço do restaurante que será exibido ao usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do restaurante.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que o restaurante está localizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do restaurante.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional O bairro (se aplicável) do restaurante.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Poster images Opcional Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9 Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Tamanho da tabela Opcional O número de pessoas no grupo de reserva Número inteiro maior que 0

EventReservationEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

String

Tamanho de texto recomendado: máximo de 50 caracteres

Horário de início Obrigatório

O carimbo de data/hora da época em que o evento deveria começar.

Observação:isso será representado em milissegundos.

Carimbo de data/hora da época em milissegundos
Modo de evento Obrigatório

Um campo para indicar se o evento será virtual, presencial ou ambos.

Enumeração: VIRTUAL, IN_PERSON ou HYBRID
Local – país Obrigatório sob certas condições

O país em que o evento acontecerá.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório sob certas condições

A cidade em que o evento vai acontecer.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório sob certas condições

O endereço ou nome do local onde o evento ocorrerá e que deve ser exibido ao usuário.

Observação:isso é necessário para eventos IN_PERSON ou HYBRID

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do local onde o evento será realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que o evento está sendo realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do local em que o evento está sendo realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional O bairro (se aplicável) onde o evento será realizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Poster images Opcional

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:é altamente recomendável usar imagens. Se um selo for fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Horário de término Opcional

O carimbo de data/hora da época em que o evento deveria terminar.

Observação:isso será representado em milissegundos.

Carimbo de data/hora da época em milissegundos
Provedor de serviços – Nome Opcional

O nome do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Texto livre. Por exemplo, o nome do organizador do evento/tour
Provedor de serviços - Imagem Opcional

O logotipo/imagem do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

Selos Opcional

Cada selo é um texto livre (máximo de 15 caracteres) ou uma imagem pequena.

Selo - Texto Opcional

Título do selo

Observação:é necessário incluir texto ou imagem para o selo.

Texto livre

Tamanho de texto recomendado: máximo de 15 caracteres

Selo - Imagem Opcional

Imagem pequena

Tratamento especial de UX, por exemplo, sobreposição de selos na miniatura da imagem/vídeo.

Observação:é necessário incluir texto ou imagem para o selo.

Consulte as orientações em Especificações de imagem.
ID da reserva Opcional O ID da reserva do evento. Texto livre
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual do ingresso/passe para o evento.

Precisa ser fornecido se o preço tachado for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original do ingresso/passe para o evento. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Classificação: valor máximo Opcional

O valor máximo da escala de avaliação.

Precisa ser fornecido se o valor atual da classificação também for informado.

Número maior ou igual a 0,0
Classificação – Valor atual Opcional

O valor atual da escala de classificação.

Precisa ser fornecido se o valor máximo de avaliação também for fornecido.

Número maior ou igual a 0,0
Classificação: quantidade Opcional

A contagem de classificações do evento.

Observação:forneça esse campo se o app quiser controlar como isso é exibido para os usuários. Forneça a string concisa que possa ser exibida para o usuário. Por exemplo, se a contagem for 1.000.000, use abreviações como 1 milhão para não aparecer truncada em telas menores.

String
Classificação: valor da contagem Opcional

A contagem de classificações do evento.

Observação:forneça esse campo se você não quiser processar a lógica de abreviação de exibição por conta própria. Quando "Count" e "Count Value" estão presentes, ele é usado para mostrar aos usuários

Longa
Categorias de conteúdo Opcional Descreva a categoria do conteúdo na entidade.

Lista de tipos enumerados qualificados

  • TYPE_FILTERS_AND_TV_SHOWS (por exemplo, cinema)
  • TYPE_DIGITAL_GAMES (por exemplo, eSports)
  • TYPE_MUSIC (por exemplo, show)
  • TYPE_TRAVEL_AND_LOCAL (por exemplo, Tour, festival)
  • TYPE_HEALTH_AND_FITENESS (Por exemplo, aula de ioga)
  • TYPE_EDUCATION (por exemplo, turma)
  • TYPE_SPORTS (por exemplo, futebol americano)
  • TYPE_DATING (por exemplo, encontro)

Consulte a seção Categoria de conteúdo para orientação.

LodgingReservationEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

Texto livre. Por exemplo, "Sua estadia de 12 de dezembro"

Tamanho de texto recomendado: máximo de 50 caracteres

Horário de check-in Obrigatório Carimbo de data/hora da época em milissegundos que representa o horário de check-in da reserva. Carimbo de data/hora da época em milissegundos
Horário de check-out Obrigatório Carimbo de data/hora da época em milissegundos que representa o horário de check-out da reserva. Carimbo de data/hora da época em milissegundos
Local – país Obrigatório O país em que a hospedagem está localizada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: cidade Obrigatório A cidade em que o hotel está localizado.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – Exibir endereço Obrigatório O endereço da hospedagem que será exibido ao usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – endereço Opcional O endereço (se aplicável) do estabelecimento.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – estado Opcional O estado ou a província (se aplicável) em que a hospedagem está localizada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local – CEP Opcional O CEP (se aplicável) do hotel.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local: bairro Opcional O bairro (se aplicável) do hotel.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Poster images Opcional

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Observação:caso um selo seja fornecido, garanta um espaço seguro de 24 dps nas partes de cima e de baixo da imagem.

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

ID da reserva Opcional O ID da reserva de hospedagem. Texto livre
Classificação: valor máximo Opcional

O valor máximo da escala de avaliação.

Precisa ser fornecido se o valor atual da classificação também for informado.

Número maior ou igual a 0,0
Classificação – Valor atual Opcional

O valor atual da escala de classificação.

Precisa ser fornecido se o valor máximo de avaliação também for fornecido.

Número maior ou igual a 0,0
Classificação: quantidade Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se o app quiser controlar como isso é exibido para os usuários. Forneça a string concisa que possa ser exibida para o usuário. Por exemplo, se a contagem for 1.000.000, use abreviações como 1 milhão para não aparecer truncada em telas menores.

String
Classificação: valor da contagem Opcional

A contagem de classificações do hotel.

Observação:forneça esse campo se você não quiser processar a lógica de abreviação de exibição por conta própria. Quando "Count" e "Count Value" estão presentes, ele é usado para mostrar aos usuários

Longa
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual da hospedagem.

Precisa ser fornecido se o preço promocional for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original da hospedagem, que aparece com desconto na interface. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

TransportationReservationEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

Texto livre. Por exemplo, "SFO para SAN"

Tamanho de texto recomendado: máximo de 50 caracteres

Tipo de transporte Obrigatório O meio/tipo de transporte para a reserva. Enumeração: VOO, TREINAMENTO, BUS ou FERRY
Horário de partida Obrigatório Carimbo de data/hora da época em milissegundos que representa o horário de partida. Carimbo de data/hora da época em milissegundos
Horário de chegada Obrigatório Carimbo de data/hora da época em milissegundos que representa o horário de chegada. Carimbo de data/hora da época em milissegundos
Local de partida: país Opcional País de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida: cidade Opcional Cidade de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida - endereço de exibição Opcional O local de partida que será exibido ao usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida: endereço Opcional O endereço (se aplicável) do local de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida: estado Opcional O estado ou a província (se aplicável) do local de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida (CEP) Opcional O CEP (se aplicável) do local de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de partida: bairro Opcional A vizinhança (se aplicável) do local de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada: país Opcional País de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada: cidade Opcional Cidade de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada: endereço de exibição Opcional O local de chegada que será exibido para o usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada: endereço Opcional O endereço (se aplicável) do local de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada - Estado Opcional O estado ou a província (se aplicável) do local de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada (CEP) Opcional O CEP (se aplicável) do local de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Local de chegada: bairro Opcional A vizinhança (se aplicável) do local de chegada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Provedor de serviços – Nome Opcional

O nome do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Texto livre. Por exemplo, nome da companhia aérea
Provedor de serviços - Imagem Opcional

O logotipo/imagem do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Consulte as orientações em Especificações de imagem.
Poster images Opcional

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

ID da reserva Opcional O ID da reserva de transporte. Texto livre
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual da reserva.

Precisa ser fornecido se o preço promocional for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original da reserva, que aparece com desconto na interface. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Número do transporte Obrigatório O número do voo, ônibus, trem ou balsa/cruzeiro Texto livre
Horário de embarque Obrigatório O carimbo de data/hora da época que representa o horário de embarque da reserva (se aplicável) Carimbo de data/hora da época em milissegundos

VehicleRentalReservationEntity

Atributo Requisito Descrição Formato
Action Uri Obrigatório

Link direto para a entidade no app do provedor.

Observação: é possível usar links diretos para atribuição. Consulte estas perguntas frequentes

URI
Título Obrigatório Título da entidade.

Texto livre. Por exemplo, "Avis Union Square SF"

Tamanho de texto recomendado: máximo de 50 caracteres

Hora de retirada Obrigatório O carimbo de data/hora da época que representa o horário de retirada da reserva. Carimbo de data/hora da época em milissegundos
Horário de retorno Opcional O carimbo de data/hora da época que representa o horário do check-out da reserva. Carimbo de data/hora da época em milissegundos
Endereço de retirada: país Opcional O país do local de retirada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada: cidade Opcional A cidade do local de retirada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada: endereço de exibição Opcional O local de retirada que será exibido ao usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada: endereço Opcional O endereço (se aplicável) do local de retirada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada – estado Opcional O estado ou a província (se aplicável) do local de retirada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada (CEP) Opcional O CEP (se aplicável) do local de retirada.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de retirada: bairro Opcional O bairro (se aplicável) do local de partida.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução: país Opcional O país de localização da devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução: cidade Opcional Cidade do local de devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução: endereço de exibição Opcional O local de retorno que será exibido para o usuário.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução: endereço Opcional O endereço (se aplicável) do local de devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução – Estado Opcional O estado ou a província (se aplicável) do local de devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução (CEP) Opcional O CEP (se aplicável) do local de devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Endereço de devolução: bairro Opcional A vizinhança (se aplicável) do local de devolução.

Texto livre

Tamanho de texto recomendado: máximo de 20 caracteres

Provedor de serviços – Nome Opcional

O nome do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Texto livre. Por exemplo, "Aluguel de carros Avis"
Provedor de serviços - Imagem Opcional

O logotipo/imagem do provedor de serviços.

Observação:texto ou imagem são obrigatórios para o provedor de serviços.

Consulte as orientações em Especificações de imagem.
Poster images Opcional

Mostramos apenas uma imagem quando várias são fornecidas. A proporção recomendada é de 16:9

Consulte as orientações em Especificações de imagem.
Descrição Opcional

Um único parágrafo de texto para descrever a entidade.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado: 180 caracteres

Lista de legendas Opcional

Até três legendas, com uma única linha de texto para cada.

Observação:a descrição ou a lista de legendas vai ser mostrada ao usuário, não ambas.

Texto livre

Tamanho de texto recomendado para cada subtítulo: máximo de 50 caracteres

ID de confirmação Opcional O ID de confirmação da reserva de aluguel do veículo. Texto livre
Preço - CurrentPrice Obrigatório sob certas condições

O preço atual da reserva.

Precisa ser fornecido se o preço promocional for informado.

Texto livre
Preço: StrikethroughPrice Opcional O preço original da reserva, que aparece com desconto na interface. Texto livre
Frase de destaque de preço Opcional Frase de destaque de preço para apresentar uma promoção, evento ou desconto para membros, se disponível.

Texto livre

Tamanho de texto recomendado: menos de 45 caracteres (um texto muito longo será mostrado com reticências)

Especificações da imagem

As especificações necessárias para recursos de imagem estão listadas nesta tabela:

Proporção Mínimo de pixels Pixels recomendados

Quadrada (1 x 1)

Preferida

300 x 300 1.200 x 1.200
Paisagem (1,91 x 1) 600 x 314 1.200 x 628
Retrato (4 x 5) 480 x 600 960 x 1.200

As imagens precisam ser hospedadas em CDNs públicas para que possam ser acessadas pelo Google.

Formatos de arquivo

PNG, JPG, GIF estático, WebP

Tamanho máximo do arquivo

5.120 KB

Recomendações adicionais

  • Área de segurança da imagem: posicione o conteúdo importante no centro da imagem, ocupando 80% do espaço.
  • Use um plano de fundo transparente para que a imagem possa ser exibida corretamente nas configurações do tema claro e escuro.

Categoria do conteúdo

A categoria de conteúdo permite que os apps publiquem conteúdo de várias categorias. Isso mapeia o conteúdo com algumas das categorias predefinidas, a saber:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

As imagens precisam ser hospedadas em CDNs públicas para que possam ser acessadas pelo Google.

Diretrizes de uso das categorias de conteúdo

  1. Algumas entidades, como ArticleEntity e GenericFeaturedEntity, estão qualificadas para usar qualquer uma das categorias de conteúdo. Para outras entidades, como EventEntity, EventReservaEntity e PointOf InterestEntity, apenas um subconjunto dessas categorias está qualificado. Verifique a lista de categorias qualificadas para um tipo de entidade antes de preenchê-la.
  2. Use o tipo de entidade específico para algumas categorias de conteúdo em uma combinação de entidades genéricas e de ContentCategory:

  3. O campo ContentCategory é opcional e precisa ser deixado em branco se o conteúdo não pertencer a nenhuma das categorias mencionadas anteriormente.

  4. Caso várias categorias de conteúdo sejam fornecidas, coloque-as na ordem de relevância para aquela com a mais relevante colocada em primeiro lugar na lista.

Etapa 2: fornecer dados do cluster

É recomendável executar o job de publicação de conteúdo em segundo plano (por exemplo, usando o WorkManager) e o programar com frequência ou por evento (por exemplo, toda vez que o usuário abrir o app ou adicionar algo ao carrinho).

AppEngagePublishClient é responsável pela publicação de clusters.

Estas são as APIs para publicar clusters no cliente:

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishContinuationCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteContinuationCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Essa API é usada para conferir se o serviço está disponível para integração e se o conteúdo pode ser apresentado no dispositivo.

Kotlin


client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java


client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

Essa API é usada para publicar uma lista de objetos RecommendationCluster.

Kotlin


client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java


client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Quando o serviço recebe a solicitação, as ações abaixo ocorrem em uma transação:

  • Os dados do RecommendationCluster do parceiro do desenvolvedor são removidos.
  • Os dados da solicitação são analisados e armazenados no cluster de recomendação atualizado.

Em caso de erro, o pedido inteiro é rejeitado e o estado atual é mantido.

publishFeaturedCluster

Essa API é usada para publicar uma lista de objetos FeaturedCluster.

Kotlin


client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java


client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Quando o serviço recebe a solicitação, as ações abaixo ocorrem em uma transação:

  • Os dados do FeaturedCluster do parceiro do desenvolvedor são removidos.
  • Os dados da solicitação são analisados e armazenados no cluster de destaque atualizado.

Em caso de erro, a solicitação inteira é rejeitada e o estado atual é mantido.

publishContinuationCluster

Essa API é usada para publicar um objeto ContinuationCluster.

Kotlin


client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java


client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Quando o serviço recebe a solicitação, as ações abaixo ocorrem em uma transação:

  • Os dados do ContinuationCluster do parceiro do desenvolvedor são removidos.
  • Os dados da solicitação são analisados e armazenados no cluster de continuação atualizado.

Em caso de erro, a solicitação inteira é rejeitada e o estado atual é mantido.

publishUserAccountManagementRequest

Essa API é usada para publicar um card de login. A ação de login direciona os usuários à página de login do app para que ele possa publicar ou oferecer conteúdo mais personalizado.

Os metadados abaixo fazem parte do card de login:

Atributo Requisito Descrição
Action Uri Obrigatório Link direto para a ação (ou seja, leva à página de login do app)
Imagem Opcional: se não for fornecido, o título precisa ser fornecido

Imagem mostrada no card

Imagens com proporção de 16 x 9 e resolução de 1.264 x 712

Título Opcional: se não for fornecido, a imagem precisará ser fornecida Título do card
Action Text Opcional Texto mostrado no CTA (por exemplo, "Fazer login")
Subtitle Opcional Subtítulo opcional do card

Kotlin


var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java


SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Quando o serviço recebe o pedido, as seguintes ações ocorrem em uma transação:

  • Os dados do UserAccountManagementCluster do parceiro do desenvolvedor são removidos.
  • Os dados do pedido são analisados e armazenados no cluster UserAccountManagementCluster atualizado.

Em caso de erro, a solicitação inteira é rejeitada e o estado existente é mantido.

updatePublishStatus

Se, por qualquer motivo interno, nenhum dos clusters for publicado, é altamente recomendável atualizar o status de publicação usando a API updatePublishStatus. Isso é importante pelos seguintes motivos:

  • Informar o status em todos os casos possíveis, mesmo quando o conteúdo é publicado (STATUS == PUBLISHED), é fundamental para preencher painéis que usam o status explícito para transmitir informações de integridade e outras métricas da integração.
  • Se nenhum conteúdo for publicado, mas o status da integração não estiver corrompido (STATUS == NOT_PUBLISHED), o Google poderá evitar o acionamento de alertas nos painéis de integridade do app. Isso confirma que o conteúdo não foi publicado devido a uma situação esperada pelo provedor.
  • Ajuda os desenvolvedores a oferecer insights sobre quando os dados foram publicados ou não.
  • O Google pode usar os códigos de status para incentivar o usuário a realizar determinadas ações no app, como acessar o conteúdo ou resolver o problema.

Lista de códigos de status de publicação que podem ser usados:

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Se o conteúdo não for publicado porque o usuário não estava conectado, o Google recomenda publicar o card de login. Se, por algum motivo, os provedores não conseguirem publicar o card de login, recomendamos chamar a API updatePublishStatus usando o código de status NOT_PUBLISHED_REQUIRES_SIGN_IN.

Kotlin


client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java


client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

Essa API é usada para excluir o conteúdo dos clusters de recomendação.

Kotlin


client.deleteRecommendationClusters()

Java


client.deleteRecommendationClusters();

Quando o serviço recebe o pedido, ele remove os dados atuais dos clusters de recomendação. Em caso de erro, a solicitação inteira é rejeitada e o estado atual é mantido.

deleteFeaturedCluster

Essa API é usada para excluir o conteúdo do cluster de destaque.

Kotlin


client.deleteFeaturedCluster()

Java


client.deleteFeaturedCluster();

Quando o serviço recebe o pedido, ele remove os dados atuais do cluster de destaque. Em caso de erro, a solicitação inteira é rejeitada e o estado existente é mantido.

deleteContinuationCluster

Essa API é usada para excluir o conteúdo do cluster de continuação.

Kotlin


client.deleteContinuationCluster()

Java


client.deleteContinuationCluster();

Quando o serviço recebe o pedido, ele remove os dados atuais do cluster de continuação. Em caso de erro, a solicitação inteira é rejeitada e o estado atual é mantido.

deleteUserManagementCluster

Essa API é usada para excluir o conteúdo do cluster UserAccountManagement.

Kotlin


client.deleteUserManagementCluster()

Java


client.deleteUserManagementCluster();

Quando o serviço recebe o pedido, ele remove os dados atuais do cluster UserAccountManagement. Em caso de erro, a solicitação inteira é rejeitada e o estado atual é mantido.

deleteClusters

Essa API é usada para excluir o conteúdo de determinado tipo de cluster.

Kotlin


client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_CONTINUATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .build())

Java


client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .build());

Quando o serviço recebe a solicitação, ele remove os dados de todos os clusters que correspondem aos tipos especificados. Os clientes podem transmitir um ou vários tipos de clusters. Em caso de erro, a solicitação inteira é rejeitada e o estado existente é mantido.

Tratamento de erros

É recomendável detectar o resultado da tarefa nas APIs de publicação. Com isso, uma ação de acompanhamento pode ser realizada para extrair e reenviar uma tarefa bem-sucedida.

Kotlin


client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java


client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

O erro é retornado como AppEngageException e a causa é incluída como um código de erro.

Código do erro Observação
SERVICE_NOT_FOUND O serviço não está disponível no dispositivo.
SERVICE_NOT_AVAILABLE O serviço está disponível no dispositivo em questão, mas não no momento da chamada (por exemplo, está desativado).
SERVICE_CALL_EXECUTION_FAILURE A execução da tarefa falhou devido a problemas de linha de execução. Nesse caso, ela pode ser repetida.
SERVICE_CALL_PERMISSION_DENIED O autor da chamada não tem permissão para fazer a chamada de serviço.
SERVICE_CALL_INVALID_ARGUMENT A solicitação contém dados inválidos (por exemplo, tem um número de clusters maior do que o permitido).
SERVICE_CALL_INTERNAL Há um erro no serviço.
SERVICE_CALL_RESOURCE_EXHAUSTED A chamada de serviço é feita com muita frequência.

Etapa 3: processar intents de transmissão

Além de fazer chamadas de API de conteúdo de publicação usando um job, também é necessário configurar um BroadcastReceiver para receber a solicitação de publicação de conteúdo.

O objetivo principal das intents de transmissão é reativar o app e forçar a sincronização de dados. As intents de transmissão não são projetadas para envio muito frequente. Elas só são acionadas quando o serviço do Engage determina que o conteúdo pode estar desatualizado (por exemplo, é de uma semana atrás). Dessa forma, há mais confiança de que o usuário poderá ter uma nova experiência de conteúdo, mesmo que o aplicativo não tenha sido executado por um longo período.

O BroadcastReceiver precisa ser configurado de duas maneiras:

  • Registre dinamicamente uma instância da classe BroadcastReceiver usando Context.registerReceiver(). Isso permite a comunicação de aplicativos que ainda estão ativos na memória.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
  // received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received

// Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is
// received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION));

}
  • Declare estaticamente uma implementação com a tag <receiver> no arquivo AndroidManifest.xml. Isso permite que o aplicativo receba intents de transmissão quando não está em execução e também permite que ele publique o conteúdo.
<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </intent-filter>
   </receiver>
</application>

As intents abaixo são enviadas pelo serviço:

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION É recomendável iniciar uma chamada publishRecommendationClusters ao receber essa intent.
  • com.google.android.engage.action.PUBLISH_FEATURED É recomendável iniciar uma chamada publishFeaturedCluster ao receber essa intent.
  • com.google.android.engage.action.PUBLISH_CONTINUATION É recomendável iniciar uma chamada publishContinuationCluster ao receber essa intent.

Fluxo de trabalho de integração

Para acessar um guia explicativo sobre como verificar a integração após a conclusão, consulte Fluxo de trabalho de integração de desenvolvedor.

Perguntas frequentes

Consulte as Perguntas frequentes sobre o SDK Engage para acessar as perguntas frequentes.

Contato

Entre em contato com engagement-developers@google.com se tiver perguntas durante o processo de integração.

Próximas etapas

Depois de concluir essa integração, as próximas etapas serão as seguintes:

  • Envie um e-mail para engage-developers@google.com e anexe o APK integrado pronto para ser testado pelo Google.
  • O Google realiza uma verificação e revisão interna para garantir que a integração funcione como esperado. Se for necessário fazer mudanças, o Google vai entrar em contato informando todos os detalhes necessários.
  • Quando o teste estiver concluído e nenhuma mudança for necessária, o Google vai entrar em contato para informar que você pode começar a publicar o APK atualizado e integrado na Play Store.
  • Depois que o Google confirmar a publicação do APK atualizado na Play Store, seus clusters de recomendação, destaque e continuação poderão ser publicados e ficar visíveis aos usuários.