Method statements.list

Recupera una lista de todas las declaraciones de una fuente determinada que coinciden con el destino y la string de instrucción especificados.

La API garantiza que el propietario de esos elementos haya realizado de manera segura todas las declaraciones con recursos de origen seguros, como sitios web HTTPS o aplicaciones para Android, como se describe en la especificación de diseño técnico de Vínculos de recursos digitales. Específicamente, debes tener en cuenta que, en el caso de sitios web no seguros (es decir, en los que la URL comienza con http:// en lugar de https://), no se puede realizar esta garantía.

El comando List es más útil en los casos en los que el cliente de la API desea conocer todas las formas en las que se relacionan dos elementos o enumerar todas las relaciones de un recurso de origen particular. Ejemplo: una función que ayuda a los usuarios a navegar a elementos relacionados. Cuando una aplicación móvil se ejecuta en un dispositivo, la función facilita la navegación al sitio web o perfil de Google+ correspondiente.

Solicitud HTTP

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

Parámetros de consulta

Nombre del parámetro Tipo Descripción
source object(Asset) La fuente que aloja la lista de instrucciones. Se usa para dirigir la solicitud List() a la fuente correcta. REQUIRED
relation string

Usa solo asociaciones que coincidan con la relación especificada.

Consulta el mensaje Statement para obtener una definición detallada de las strings de relación.

Para que una consulta coincida con una instrucción, se debe cumplir una de las siguientes condiciones:

  • Las strings de relación de la consulta y la declaración coinciden de forma exacta.
  • falta la string de relación de la consulta.

Ejemplo: Una consulta con la relación delegate_permission/common.handle_all_urls coincide con un vínculo de elemento con la relación delegate_permission/common.handle_all_urls.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Mensaje de respuesta para la llamada de lista.

Representación JSON
{
  "statements": [
    {
      object(Statement)
    }
  ],
  "maxAge": string,
  "debugString": string,
}
Nombre del campo Tipo Descripción
statements[] object(Statement) Una lista de todas las declaraciones coincidentes que se encontraron.
maxAge string

Desde el momento de la publicación, cuánto tiempo más se debe considerar la respuesta como válida, tras la prohibición de las actualizaciones. REQUIRED

Es una duración en segundos con hasta nueve dígitos fraccionarios que termina en "s". Ejemplo: "3.5s".

debugString string

Mensaje legible que incluye información destinada a ayudar a los usuarios finales a comprender, reproducir y depurar el resultado.

El mensaje se mostrará en inglés y, por el momento, no planeamos ofrecer traducciones.

Tenga en cuenta que no se garantiza el contenido ni el formato de esta cadena. Cualquier aspecto puede estar sujeto a cambios sin previo aviso. No debes intentar analizar estos datos de manera programática. Si considera que necesita hacerlo porque la API no expone la información que necesita, comuníquese con nosotros primero.

Declaración

Describe una declaración confiable que se haya hecho sobre la relación entre un elemento de origen y uno de destino.

Las declaraciones siempre las realiza el activo de origen, ya sea de forma directa o mediante la delegación de una lista de declaraciones que se almacena en otro lugar.

Para obtener definiciones más detalladas de las declaraciones y los recursos, consulte nuestra página de destino de la documentación de la API.

Representación JSON
{
  "source": {
    object(Asset)
  },
  "relation": string,
  "target": {
    object(Asset)
  },
}
Nombre del campo Tipo Descripción
source object(Asset) Cada instrucción tiene un recurso de origen. REQUIRED
relation string

La relación identifica el uso de la declaración según lo previsto por el propietario del activo de origen (es decir, la persona o entidad que emitió la declaración). Cada instrucción completa tiene una relación.

Identificamos relaciones con strings del formato <kind>/<detail>, en el que <kind> debe ser parte de un conjunto de categorías de propósito predefinidas, y <detail> es una string alfanumérica en formato libre en minúscula que describe el caso de uso específico de la declaración.

Consulta nuestra documentación de la API para ver la lista actual de relaciones admitidas.

Ejemplo: delegate_permission/common.handle_all_urls OBLIGATORIO

target object(Asset) Cada resumen tiene un elemento de destino. REQUIRED

Pruébela.

Usa el Explorador de API para llamar a este método en datos en vivo y ver la respuesta.