Method statements.list

Recupera una lista de todas las sentencias de una fuente determinada que coinciden con el objetivo y la cadena de instrucción especificados.

La API garantiza que todas las declaraciones con recursos de fuente segura, como sitios web HTTPS o apps para Android, hayan sido realizadas de manera segura por el propietario de esos recursos, 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 no se puede garantizar esta garantía en el caso de los sitios web no seguros (es decir, en los que la URL comienza con http:// en lugar de https://).

El comando List es más útil cuando el cliente de la API desea conocer todas las formas en que dos elementos están relacionados o enumerar todas las relaciones de un recurso de origen en 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 al 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 declaraciones. 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 cadenas de relación.

Para que una consulta coincida con una afirmación, una de las siguientes opciones debe ser verdadera:

  • las cadenas de relación de la consulta y de la instrucción coinciden exactamente, o
  • la cadena de relación de la consulta está vacía o falta.

Ejemplo: Una consulta con la relación delegate_permission/common.handle_all_urls coincide con un vínculo de elementos 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 List.

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

A partir del tiempo de publicación, indica durante cuánto tiempo la respuesta debe considerarse válida, excepto las actualizaciones adicionales. REQUIRED

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

Mensaje legible por humanos que contiene 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 ninguna traducción.

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

Declaración

Describe una afirmación confiable sobre la relación entre un recurso de origen y un recurso de destino.

Las declaraciones siempre las realiza el recurso de origen, ya sea de forma directa o delegándolas a una lista de declaraciones almacenada en otro lugar.

Para obtener definiciones más detalladas de los resúmenes y los recursos, consulta 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 sentencia 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 la emitió). Cada instrucción completa tiene una relación.

Identificamos relaciones con cadenas del formato <kind>/<detail>, en las que <kind> debe ser una de un conjunto de categorías de propósito predefinidas, y <detail> es una cadena alfanumérica en minúscula de formato libre que describe el caso de uso específico de la instrucció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 sentencia tiene un recurso objetivo. REQUIRED

Pruébalo

Utiliza el Explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.