Method statements.list

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

A API garante que todas as instruções com recursos de origem seguros, como sites HTTPS ou apps Android, tenham sido feitas de forma segura pelo proprietário desses recursos, conforme descrito na especificação técnica do design de recursos digitais. 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 formas com que dois recursos estão relacionados ou enumerar todas as relações de um recurso de origem específico. Exemplo: um recurso que ajuda os usuários a navegar até itens relacionados. Quando um app para dispositivos móveis é executado em um dispositivo, o recurso facilita a navegação até o site ou o 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) A fonte que hospeda a lista de instruções. Isso é usado para direcionar a solicitação List() para a origem correta. REQUIRED
relation string

Use somente associações que correspondam à relação especificada.

Consulte a mensagem Statement para ver 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:

  • as strings de relação da consulta e da instrução corresponderem exatamente ou
  • a string de relação da consulta está vazia ou ausente.

Exemplo: uma consulta com a 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, quanto tempo a resposta deve ser considerada válida, com exceção das 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 que contém 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.

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

Instrução

Descreve uma declaração confiável sobre a relação entre os recursos de origem e 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 local.

Para definições mais detalhadas de instruçõ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) Cada instrução tem um recurso de origem. REQUIRED
relation string

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

Identificamos relações com strings no formato <kind>/<detail>, em que <kind> precisa ser um conjunto de categorias de objetivos pré-definidas, e <detail> é uma string alfanumérica em formato livre que descreve o caso de uso específico da instrução.

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

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

Confira!

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