Method statements.list

Recupera uma lista de todas as instruções de uma determinada fonte que corresponde ao destino e à string de instrução especificados.

A API garante que todas as declarações com recursos de origem seguros, como sites HTTPS ou apps Android, sejam feitas de maneira segura pelo proprietário desses recursos, conforme descrito na especificação do design técnico do Digital Asset Links. Especificamente, considere que, para sites não seguros (ou seja, em que o URL começa com http:// em vez de https://), essa garantia não pode ser feita.

O comando List é mais útil nos casos em que o cliente da API quer saber todas as maneiras como dois recursos estão relacionados ou enumerar todas as relações de um determinado recurso de origem. Exemplo: um recurso que ajuda os usuários a navegar para itens relacionados. Quando um aplicativo móvel está sendo executado em um dispositivo, o recurso facilitaria a navegação para o site ou perfil do Google+ correspondente.

Solicitação HTTP

GET https://digitalassetlinks.googleapis.com/v1/statements:list

Parâmetros de consulta

Nome do parâmetro Tipo Descrição
source object(Asset) Fonte que hospeda a lista de instruções. É usado para direcionar a solicitação List() para a origem correta. REQUIRED
relation string

Usa apenas associações que correspondam à relação especificada.

Consulte a mensagem Statement para uma definição detalhada das strings de relação.

Para que uma consulta corresponda a uma instrução, uma das seguintes condições precisa ser verdadeira:

  • se as strings de relação da consulta e da instrução são exatamente iguais, ou
  • se a string de relação da consulta estiver vazia ou ausente.

Exemplo: uma consulta com relação delegate_permission/common.handle_all_urls corresponde a um link de recurso com a relação delegate_permission/common.handle_all_urls.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Mensagem de resposta para a chamada de List.

Representação JSON 
{
  "statements": [
    {
      object(Statement)
    }
  ],
  "maxAge": string,
  "debugString": string,
}
Nome do campo Tipo Descrição
statements[] object(Statement) Uma lista de todas as instruções correspondentes que foram encontradas.
maxAge string

A partir do momento da veiculação, o tempo de espera da resposta deve ser considerada válida, exceto no caso de futuras atualizações. REQUIRED

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".
debugString string

Mensagem legível por humanos contendo informações destinadas a ajudar os usuários finais a entender, reproduzir e depurar o resultado.

A mensagem será em inglês e não planejamos oferecer traduções no momento.

Nenhuma garantia é feita em relação ao conteúdo ou formato dessa string. Qualquer aspecto dele pode estar sujeito a alterações sem aviso prévio. Não tente analisar esses dados de forma programática. Se você acha que precisa fazer isso porque as informações necessárias não estão sendo expostas pela API, entre em contato primeiro.

Instrução

Descreve uma declaração confiável feita sobre a relação entre um recurso de origem e um recurso de destino.

As instruções são sempre feitas pelo recurso de origem, seja diretamente ou delegando a uma lista de instruções armazenada em outro lugar.

Para definições mais detalhadas de declarações e recursos, consulte a página de destino da documentação da API.

Representação JSON 
{
  "source": {
    object(Asset)
  },
  "relation": string,
  "target": {
    object(Asset)
  },
}
Nome do campo Tipo Descrição
source object(Asset) Toda instrução tem um recurso de origem. REQUIRED
relation string

A relação identifica o uso da instrução conforme pretendido pelo proprietário do recurso de origem (ou seja, a pessoa ou entidade que emitiu a declaração). Toda instrução completa tem uma relação.

Identificamos relações com strings do formato <kind>/<detail>, em que <kind> precisa ser um de um conjunto de categorias de finalidade predefinidas, e <detail> é uma string alfanumérica em letras minúsculas de formato livre que descreve o caso de uso específico da instrução.

Consulte a documentação da API para a lista atual de relações compatíveis.

Exemplo: delegate_permission/common.handle_all_urls REQUIRED
target object(Asset) Toda instrução tem um recurso de destino. REQUIRED

Confira!

Use o APIs Explorer para chamar esse método em dados em tempo real e ver a resposta.