Desenvolvedores do Espaço Econômico Europeu (EEE)

Escolher os campos a serem retornados

Ao solicitar uma rota ou matriz de rotas, use uma máscara de campo para especificar quais informações a resposta precisa retornar. Não há uma lista padrão de campos retornados. Se você não especificar uma máscara de campo, os métodos vão retornar um erro.

O uso de uma máscara de campo também garante que você não solicite dados desnecessários, o que ajuda na latência da resposta e evita o retorno de informações que seu sistema não precisa.

Você especifica a lista dos campos necessários em uma máscara de campo de resposta. Em seguida, transmita a máscara de campo de resposta para qualquer um dos métodos usando o parâmetro de URL $fields ou fields, ou usando o cabeçalho HTTP ou gRPC X-Goog-FieldMask.

Para mais informações sobre parâmetros de URL, consulte Parâmetros de sistema.

Definir uma máscara de campo de resposta

A máscara de campo de resposta é uma lista de caminhos separados por vírgulas, em que cada caminho especifica um campo exclusivo na mensagem de resposta. O caminho começa na mensagem de resposta de nível superior e usa um caminho separado por pontos para o campo especificado.

Construa e especifique um caminho de campo da seguinte maneira:

  1. Encontre os campos que contêm as informações necessárias. Para mais detalhes, consulte Referências de campo.
  2. Determine os caminhos dos campos necessários e construa as máscaras de campo para eles: para mais detalhes, consulte Determinar qual máscara de campo você quer usar.

  3. Combine as máscaras de campo de todos os campos necessários, separando-as com vírgulas. Por exemplo, para solicitar o distanceMeters da etapa da rota, além da duração de cada etapa da rota, insira os dois, separados por uma vírgula, sem espaços:

    routes.legs.distanceMeters,routes.legs.steps.duration

  4. Envie a máscara de campo com a solicitação de API. Por exemplo, em uma solicitação curl, você especificaria a máscara de campo com -H e X-Goog-FieldMask:

    -H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
Para exemplos e mais detalhes, consulte as seções a seguir.

Referências de campo

Para conferir os campos que podem ser solicitados em uma resposta por máscaras de campo, consulte as referências da API Routes Compute Routes ou Compute Route Matrix vinculadas na lista a seguir. Especifique os campos em camel case, conforme mostrado na referência. Por exemplo, routePreference.

Essas referências incluem os campos disponíveis. No entanto, é necessário consultar a hierarquia dos campos para determinar o caminho completo da máscara de campo. Para mais detalhes sobre como acessar a hierarquia dos campos, consulte Determinar qual máscara de campo você quer usar.

  • Máscara de campo de rota de computação
    • REST: especifica os campos do Route objeto na resposta a ser retornada, com o prefixo routes., por exemplo, routes.distanceMeters.
    • gRPC: especifica os campos do Route objeto na resposta a ser retornada.
  • Máscaras de campo da matriz de rotas de computação

Determinar quais máscaras de campo usar

Veja como determinar quais campos você quer usar e construir as máscaras de campo para eles:

  1. Solicite todos os campos usando uma máscara de campo de *.
  2. Confira a hierarquia dos campos na resposta para os campos desejados.

  3. Construa suas máscaras de campo usando a hierarquia dos campos mostrada na etapa anterior, usando este formato:

    topLevelField[.secondLevelField][.thirdLevelField][...]

Por exemplo, para esta resposta parcial de uma rota:

"routes": [
    {
        "legs": [
            {  "steps": [
                    {"distanceMeters": 119},
                    {"distanceMeters": 41}  ]
            }
        ],
        "distanceMeters": 160
    }
]

Se você quiser retornar apenas o campo distanceMeters da etapa da rota, ou seja, o último distanceMeters no exemplo anterior, sua máscara de campo será a seguinte:

routes.legs.distanceMeters

Se você quiser retornar o campo distanceMeters para cada etapa da etapa da rota, ou seja, o distanceMeters em steps no exemplo anterior, sua máscara de campo será a seguinte:

routes.legs.steps.distanceMeters

Se você quiser retornar os dois, com o resultado acima, sua máscara de campo será a seguinte:

routes.legs.distanceMeters,routes.legs.steps.distanceMeters

Exemplos de caminhos de máscara de campo

Esta seção contém mais exemplos de como especificar um caminho de campo como parte de uma máscara de campo de resposta em chamadas REST e gRPC.

Chamada REST para computeRoutes

No primeiro exemplo, você usa uma chamada REST para o computeRoutes método para calcular uma rota. Neste exemplo, no cabeçalho, você especifica máscaras de campo para retornar os campos distanceMeters e duration da rota na resposta. Lembre-se de prefixar o nome do campo por routes.

X-Goog-FieldMask: routes.distanceMeters,routes.duration

Chamada REST para computeRouteMatrix

Para o método REST computeRouteMatrix usado para calcular uma matriz de rotas, no cabeçalho, especifique para retornar originIndex, destinationIndex, e duration para cada combinação de origem e destino:

X-Goog-FieldMask: originIndex,destinationIndex,duration

Chamada gRPC para computeRoutes

Para o método gRPC computeRoutes usado para calcular uma rota, defina uma variável que contenha a máscara de campo de resposta para retornar os campos distanceMeters, duration e polilinha codificada na resposta. Em seguida, transmita essa variável para a solicitação:

const (
  fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline"
)

Chamada gRPC para computeRouteMatrix

Para o método gRPC computeRouteMatrix usado para calcular uma matriz de rotas, defina uma variável que contenha a máscara de campo de resposta para especificar o retorno de originIndex, destinationIndex e duration para cada combinação de origem e destino. Em seguida, transmita essa variável para a solicitação:

const (
  fieldMask = "originIndex,destinationIndex,duration"
)

Considerações sobre o caminho do campo

Inclua apenas os campos necessários na resposta para retornar apenas os campos necessários:

  • Diminui os tempos de processamento, para que os resultados sejam retornados com uma latência menor.
  • Garante um desempenho de latência estável. Se você selecionar todos os campos ou todos os campos no nível superior, poderá ocorrer uma degradação de desempenho quando novos campos forem adicionados e incluídos automaticamente na resposta.
  • Resulta em um tamanho de resposta menor, o que se traduz em maior capacidade de processamento de rede.
  • Garante que você não solicite dados desnecessários, o que ajuda a evitar tempo de processamento desnecessário e cobranças faturadas.

Para mais detalhes sobre como construir uma máscara de campo, consulte o field_mask.proto.