Method statements.list

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

Die API garantiert, dass alle Anweisungen mit sicheren Quell-Assets, wie z. B. HTTPS-Websites oder Android-Apps, sicher vom Inhaber der jeweiligen Inhalte stammen. Weitere Informationen dazu finden Sie in der technischen Spezifikation „Digital Asset Links“. Insbesondere bei unsicheren Websites, bei denen die URL mit http:// statt https:// beginnt, ist diese Garantie nicht möglich.

Der Befehl List ist besonders dann nützlich, wenn der API-Client wissen möchte, wie zwei Assets miteinander in Beziehung stehen oder alle Beziehungen eines bestimmten Quell-Assets aufzählen. Beispiel: Eine Funktion, mit der Nutzer ähnliche Artikel finden können. Wenn eine mobile App auf einem Gerät ausgeführt wird, können Sie damit die entsprechende Website oder das Google+ Profil ganz einfach aufrufen.

HTTP-Anfrage

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

Abfrageparameter

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

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

Eine detaillierte Definition von Beziehungsstrings finden Sie in der Nachricht Statement.

Eine Abfrage, die einer Anweisung entspricht, muss einer der folgenden Punkte entsprechen:

  • die Beziehungsstrings der Abfrage und der Anweisung stimmen genau überein oder
  • Der Beziehungsstring der Abfrage ist leer oder fehlt.

Beispiel: Eine Abfrage mit der Beziehung delegate_permission/common.handle_all_urls stimmt mit einer Asset-Verknüpfung mit der Beziehung delegate_permission/common.handle_all_urls überein.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Antwortnachricht für den List-Aufruf.

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 Bereitstellung, wie lange die Antwort als gültige Aktualisierungen zu betrachten ist, abgesehen von weiteren Aktualisierungen. ERFORDERLICH

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

Für Menschen lesbare Nachricht mit Informationen, die Endnutzern helfen sollen, das Ergebnis zu verstehen, zu reproduzieren und Fehler zu beheben.

Die Nachricht wird in englischer Sprache verfasst. Derzeit sind aber keine Übersetzungen verfügbar.

Beachten Sie, dass der Inhalt oder das Format dieses Strings nicht garantiert werden kann. Jeder Aspekt kann sich ohne vorherige Ankündigung ändern. Sie sollten nicht versuchen, diese Daten programmatisch zu parsen. Wenn Sie der Meinung sind, dass dies erforderlich ist, weil die benötigten Informationen ansonsten nicht über die API bereitgestellt werden, wenden Sie sich bitte zuerst an uns.

Aussage

Beschreibt eine verlässliche Aussage zur Beziehung zwischen einem Quell-Asset und einem Ziel-Asset.

Anweisungen werden immer vom Quell-Asset erstellt, entweder direkt oder durch Delegieren an eine an anderer Stelle gespeicherte Anweisungsliste.

Detaillierte Definitionen für Anweisungen und Assets finden Sie auf unserer Landingpage für die 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 an, wie die Anweisung vom Inhaber des Quell-Assets, d. h. von der Person oder Rechtspersönlichkeit, die die Abrechnung erstellt hat, verwendet wird. Jede vollständige Aussage hat eine Beziehung.

Wir ermitteln Beziehungen mit Strings im Format <kind>/<detail>, wobei <kind> einer der vordefinierten Zweckkategorien sein muss und <detail> ein frei definierbarer kleingeschriebener alphanumerischer String 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 ERFORDERLICH
target object(Asset) Jede Anweisung hat ein Ziel-Asset. ERFORDERLICH

Testen!

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