Escolha os campos a serem retornados

Ao chamar o método ComputeRoutes(), especifique quais campos você quer retornar na resposta. Para isso, use uma máscara de campo de resposta, fornecida com o parâmetro de URL $fields ou fields, ou usando o cabeçalho HTTP/gRPC X-Goog-FieldMask. Para mais informações, consulte Parâmetros do sistema.

Máscara de campo

O valor da máscara de campo é uma lista separada por vírgulas de caminhos de campo. Cada caminho de campo é uma lista separada por pontos de nomes de campo que representam a hierarquia de mensagens. Um nome de campo é a chave do objeto JSON ou o nome da tag de campo protobuf. O caminho do campo começa no tipo de mensagem de resposta de nível superior e, opcionalmente, é seguido por um ou mais pontos e, em seguida, pelo próximo nível do nome do campo. Em geral, os caminhos de campo são construídos da seguinte maneira:

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

Uma máscara de campo de caso especial é um caractere curinga "*", que seleciona todos os campos no nível da raiz.

Exemplos

O exemplo a seguir demonstra como definir máscaras de campo para o método ComputeRoutes().

Exemplo 1

Máscara de campo de todos os campos disponíveis (para inspeção manual).

X-Goog-FieldMask: *

Exemplo 2

Máscara de campo de duração, distância e polilinha no nível do trajeto (um exemplo de configuração de produção).

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

Não recomendamos o uso da máscara de campo de resposta de caractere curinga (*) ou a especificação da máscara de campo no nível superior (rotas) na produção. Selecionar apenas os campos necessários:

  • Permite que nosso servidor salve ciclos de processamento, o que nos permite retornar seus resultados com uma latência menor.

  • Garante um desempenho de latência estável. Podemos adicionar mais campos de resposta no futuro, e esses novos campos podem exigir mais tempo de computação. Se você selecionar todos os campos ou todos os campos no nível superior, poderá notar uma degradação no desempenho, porque todos os novos campos adicionados serão incluídos automaticamente na resposta.

  • Resulta em um tamanho de resposta menor, o que se traduz em maior capacidade de rede.

Para mais informações sobre como construir caminhos de campo, consulte field_mask.proto.