Method: annotatePaths (Automotive)

Retorna os caminhos com base em segmentos de entrada de volta com anotações para atributos dinâmicos ao longo dos caminhos.

Solicitação HTTP

POST https://routes.googleapis.com/annotations/v2:annotatePaths

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "paths": [
    {
      object (Path)
    }
  ],
  "annotationOptions": {
    object (AnnotationOptions)
  }
}
Campos
paths[]

object (Path)

Obrigatório. As rotas solicitadas a serem preenchidas com dados de atributo dinâmico. Todos os caminhos precisam ter o mesmo trecho de partida, sendo o trecho em que o veículo está no momento. O veículo está no início do primeiro trecho. Se os caminhos não começarem no mesmo segmento, será retornado um erro.
annotationOptions

object (AnnotationOptions)

Obrigatório. Os atributos de dados dinâmicos solicitados que precisam ser adicionados aos caminhos de entrada. Se estiver vazia, a solicitação não será anotada.

Corpo da resposta

A annotatePathsResponse contém os caminhos de entrada com mais dados para todas as anotações solicitadas.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "annotatedPaths": [
    {
      object (AnnotatedPath)
    }
  ]
}
Campos
annotatedPaths[]

object (AnnotatedPath)

Caminhos da entrada anotada com atributos solicitados.

Caminho

Um caminho em que atributos dinâmicos estão sendo solicitados.

Um caminho precisa ter segmentos conectados e com acesso. Os segmentos de um caminho seguem um trajeto lógico e, se não for possível encontrar uma rota nos segmentos de entrada, será retornado um erro. Por exemplo, se os segmentos de um caminho não tiverem pontos de extremidade de conexão ou se o caminho estiver vazio, ocorrerá um erro.

No momento, o caminho está limitado a 15 km de extensão. O caminho é medido a partir do início do primeiro trecho, a localização do veículo presumida. Um erro será retornado se um trecho de um caminho começar a mais de 15 km do início do primeiro trecho. É aceitável que o último trecho comece antes de 15 km e termine após 15 km. Não será retornada nenhuma resposta parcial.

Um caminho pode conter os mesmos segmentos que outro caminho, mas é possível que as anotações de segmento contenham respostas diferentes, com base nas diferenças em outras partes do caminho.

Representação JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ]
}
Campos
segments[]

object (Segment)

Obrigatório. Uma lista ordenada de segmentos que formam o caminho.

Segmento

Um segmento que pertence a um caminho.

Representação JSON 
{
  "polyline": {
    object (Polyline)
  },

  // Union field id can be only one of the following:
  "placeId": string
  // End of list of possible types for union field id.
}
Campos
polyline

object (Polyline)

Obrigatório. A polilinha do segmento, que pode ser usada para identificar o segmento se o ID não puder ser encontrado e também para diferenciar entre dois segmentos se eles tiverem o mesmo ID. A polilinha é codificada usando o formato de algoritmo de polilinhas codificadas padrão da Plataforma Google Maps.
Campo de união id. Usado para identificar este segmento dentro de um espaço de ID. Obrigatório. id pode ser apenas de um dos tipos a seguir:
placeId

string

O ID de lugar desse trecho de via. Usado em várias APIs.

AnnotationOptions

Anotações solicitadas para os caminhos de entrada.

Representação JSON 
{
  "includeLevelOfService": boolean
}
Campos
includeLevelOfService

boolean

Opcional. Quando ela é definida como verdadeira, os segmentos da resposta são anotados com os valores de tráfego previstos. "Nível de serviço" é um termo geralmente usado para descrever a categorização do fluxo de tráfego, mas o nível das definições de serviço nesta API pertence somente a ela.

AnnotatedPath

Uma cópia de um caminho de entrada retornado com atributos previstos.

Representação JSON 
{
  "annotatedSegments": [
    {
      object (AnnotatedSegment)
    }
  ]
}
Campos
annotatedSegments[]

object (AnnotatedSegment)

Uma lista ordenada de segmentos que formam o caminho principal, anotada com os atributos solicitados.

AnnotatedSegment

Um segmento que cria um caminho, anotado com atributos de dados dinâmicos.

Representação JSON 
{
  "segment": {
    object (Segment)
  },
  "segmentSpanAttributes": [
    {
      object (SegmentSpanAttribute)
    }
  ]
}
Campos
segment

object (Segment)

Detalhes usados para diferenciá-lo de outros segmentos.
segmentSpanAttributes[]

object (SegmentSpanAttribute)

São os atributos atribuídos ao trecho. Esses atributos podem variar de acordo com o caminho em que o segmento está. Um período pode abranger todo o segmento. Os vãos dos atributos vão estar em ordem progressiva, do local do veículo até o fim do caminho.

SegmentSpanAttribute

Um SegmentSpanAttribute contém as anotações retornadas da API.

Representação JSON 
{
  "segmentSpan": {
    object (SegmentSpan)
  },
  "levelOfService": enum (LevelOfService)
}
Campos
segmentSpan

object (SegmentSpan)

Descreve onde as anotações se aplicam no segmento.
levelOfService

enum (LevelOfService)

O nível de tráfego previsto para a extensão do trecho, definido pelas velocidades de trânsito esperadas nesse trecho quando o veículo chega no início dele.

SegmentSpan

Usado para delimitar uma subseção de um trecho. Se um período cobrir todo o segmento, startMeters será 0 e endMeters será o comprimento do trecho.

Representação JSON 
{
  "startMeters": integer,
  "endMeters": integer
}
Campos
startMeters

integer

Onde o início do período é a partir do ponto inicial da polilinha do segmento.
endMeters

integer

O ponto final do período é a partir do ponto inicial da polilinha do segmento.

LevelOfService

Valores previstos do bucket de tráfego, a serem usados para a funcionalidade do ADAS, que mapeiam os níveis gerais de tráfego. Os valores retornados por essa API são independentes e não devem corresponder a outras APIs.

Enums
LEVEL_OF_SERVICE_UNSPECIFIED Valor padrão. Esse valor significa que não há valor de tráfego previsto disponível.
LEVEL_OF_SERVICE_STOPPED O tráfego foi interrompido.
LEVEL_OF_SERVICE_STOP_AND_GO O trânsito está indo embora.
LEVEL_OF_SERVICE_SLOW Há previsão de lentidão, mas não há engarrafamentos.
LEVEL_OF_SERVICE_NORMAL Velocidade normal, nenhuma lentidão prevista.