Method statements.list

Ruft eine Liste aller Anweisungen aus einer bestimmten Quelle ab, die mit dem angegebenen Ziel- und Anweisungsstring übereinstimmen.

Die API garantiert, dass alle Aussagen mit sicheren Quell-Assets, z. B. HTTPS-Websites oder Android-Apps, vom Inhaber dieser Assets auf sichere Weise abgegeben wurden, wie in der technischen Designspezifikation zu Digital Asset Links beschrieben. Insbesondere ist zu beachten, dass diese Garantie für unsichere Websites nicht gegeben werden kann, wenn die URL mit http:// und nicht mit https:// beginnt.

Der Befehl List ist am nützlichsten, wenn der API-Client wissen möchte, wie zwei Assets zusammenhängen, oder alle Beziehungen aus einem bestimmten Quell-Asset aufzählen möchte. Beispiel: eine Funktion, mit der Nutzende zu ähnlichen Elementen navigieren können. Wenn eine mobile App auf einem Gerät ausgeführt wird, erleichtert die Funktion die Navigation zur entsprechenden Website bzw. zum entsprechenden Google+ Profil.

HTTP-Anfrage

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

Abfrageparameter

Parametername Typ Beschreibung
source object(Asset) Die Quelle, die die Anweisungsliste hostet. Damit wird die List()-Anfrage an die richtige Quelle weitergeleitet. ERFORDERLICH
relation string

Verwenden Sie nur Verknüpfungen, die der angegebenen Beziehung entsprechen.

Eine ausführliche Definition von Beziehungsstrings finden Sie in der Nachricht Statement.

Damit eine Abfrage mit einer Anweisung übereinstimmt, muss eine der folgenden Bedingungen zutreffen:

  • dass die Beziehungsstrings der Abfrage und die Anweisung genau übereinstimmen, oder
  • der Beziehungsstring der Abfrage ist leer oder fehlt.

Beispiel: Eine Abfrage mit der Beziehung delegate_permission/common.handle_all_urls stimmt mit einem Asset-Link mit der Beziehung delegate_permission/common.handle_all_urls überein.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

Antwortnachricht für den Listenaufruf.

JSON-Darstellung 
{
  "statements": [
    {
      object(Statement)
    }
  ],
  "maxAge": string,
  "debugString": string,
}
Feldname Typ Beschreibung
statements[] object(Statement) Eine Liste aller gefundenen übereinstimmenden Anweisungen.
maxAge string

Ab dem Zeitpunkt der Auslieferung, wie lange die Antwort gültig sein soll, solange keine weiteren Aktualisierungen erfolgen. ERFORDERLICH

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's' an letzter Stelle. Beispiel: "3.5s".
debugString string

Eine visuell lesbare Nachricht mit Informationen, die Endnutzern helfen sollen, das Ergebnis zu verstehen, zu reproduzieren und zu debuggen.

Die Mitteilung wird auf Englisch verfasst und derzeit ist nicht geplant, sie zu übersetzen.

Beachten Sie, dass hinsichtlich des Inhalts oder Formats dieses Strings keine Garantien gegeben werden. Alle Teile davon können ohne vorherige Ankündigung geändert werden. Sie sollten nicht versuchen, diese Daten programmatisch zu parsen. Wenn Sie dies Ihrer Meinung nach tun müssen, weil die von Ihnen benötigten Informationen über die API nicht anderweitig offengelegt werden, setzen Sie sich bitte zuerst mit uns in Verbindung.

Aussage

Beschreibt eine zuverlässige Aussage über die Beziehung zwischen einem Quell-Asset und einem Ziel-Asset.

Anweisungen werden immer vom Quell-Asset erstellt, entweder direkt oder durch Delegieren an eine Anweisungsliste, die an einem anderen Ort gespeichert ist.

Detailliertere Definitionen von Anweisungen und Assets finden Sie auf unserer Landingpage der API-Dokumentation.

JSON-Darstellung 
{
  "source": {
    object(Asset)
  },
  "relation": string,
  "target": {
    object(Asset)
  },
}
Feldname Typ Beschreibung
source object(Asset) Jede Anweisung hat ein Quell-Asset. ERFORDERLICH
relation string

Die Beziehung gibt die Verwendung der Anweisung an, wie vom Rechteinhaber des Quell-Assets (d. h. der Person oder Rechtspersönlichkeit, die die Anweisung ausgestellt hat) beabsichtigt. Jede vollständige Anweisung verfügt über eine Beziehung.

Wir identifizieren Beziehungen mit Strings im Format <kind>/<detail>, wobei <kind> eine aus einer Reihe vordefinierter Zweckkategorien sein muss und <detail> ein kleingeschriebener alphanumerischer String im freien Format ist, der den spezifischen Anwendungsfall der Anweisung beschreibt.

Eine aktuelle Liste der unterstützten Beziehungen finden Sie in unserer API-Dokumentation.

Beispiel: delegate_permission/common.handle_all_urls REQUIRED
target object(Asset) Jede Anweisung hat ein Ziel-Asset. ERFORDERLICH

Jetzt testen

Rufen Sie diese Methode mit dem APIs Explorer für Live-Daten auf und sehen Sie sich die Antwort an.