DokumentationAdobe PassAdobe Pass-Authentifizierung

Benutzermetadaten user-metadata

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Der Inhalt dieser Seite dient nur Informationszwecken. Für die Verwendung dieser API ist eine aktuelle Lizenz von Adobe erforderlich. Eine unbefugte Anwendung ist nicht zulässig.
NOTE
Die REST-API-Implementierung wird durch Drosselmechanismus

REST-API-Endpunkte clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Beschreibung description

Abrufen von Metadaten, die MVPD über den authentifizierten Benutzer freigegeben hat.

Endpunkt
aufgerufen
von
Eingabe
Parameter
HTTP
Methode
Reaktion
HTTP
Reaktion
<SP_FQDN>/api/v1/tokens/usermetadata
Streaming-App

oder

Programmiererdienst
1. Antragsteller
2. deviceId (Obligatorisch)
3. device_info/X-Device-Info (erforderlich)
4. deviceType
5. deviceUser (nicht mehr unterstützt)
6. appId (nicht mehr unterstützt)
GET
XML oder JSON, die Benutzermetadaten oder Fehlerdetails enthalten, falls dies nicht erfolgreich war.

200 - Erfolg

404 - Keine Metadaten gefunden

412 - Ungültiges AuthN-Token (z. B. abgelaufenes Token)

Eingabeparameter
Beschreibung
Anfragender
Die Programmer-Anfrage-ID, für die dieser Vorgang gültig ist.
deviceId
Die Geräte-ID-Bytes.

device_info/

X-Device-Info

Informationen zum Streaming-Gerät.

Hinweis: Dieser Parameter kann als URL-Parameter an device_info übergeben werden. Aufgrund der potenziellen Größe dieses Parameters und der Längenbeschränkungen einer GET-URL sollte er jedoch als X-Device-Info in der HTTP-Kopfzeile übergeben werden.

Weitere Informationen finden Sie unter Weitergeben von Geräte- und Verbindungsinformationen.
deviceType
Der Gerätetyp (z. B. Roku, PC).

Wenn dieser Parameter korrekt festgelegt ist, bietet ESM Metriken an, die aufgeschlüsselt nach Gerätetyp bei Verwendung von ClientLess, sodass verschiedene Arten der Analyse für z. B. Roku, AppleTV, Xbox usw. durchgeführt werden können.

Siehe Vorteile der Verwendung des Parameters für Client-lose Gerätetypen in Pass-Metriken

Hinweis: Die device_info ersetzt diesen Parameter.
deviceUser
Die Benutzer-ID des Geräts.

Hinweis: Falls verwendet, deviceUser sollte dieselben Werte wie im Registrierungscode erstellen -Anfrage.
appId
Die Anwendungs-ID/der Name.

Hinweis: Die device_info ersetzt diesen Parameter. Falls verwendet, appId sollte dieselben Werte wie im Registrierungscode erstellen -Anfrage.
NOTE
Benutzer-Metadateninformationen sollten nach Abschluss des Authentifizierungsflusses verfügbar sein, können jedoch je nach MVPD und Metadatentyp über den Autorisierungsfluss aktualisiert werden.

Beispielantwort sample-response

Nach einem erfolgreichen Aufruf antwortet der Server mit einem XML- (Standard-) oder JSON-Objekt mit einer Struktur, die der unten dargestellten ähnelt:

    {
        updated: 1334243471,
        encrypted: ["encryptedProp"],
        data: {
              zip: ["12345", "34567"],
              maxRating: {
                  "MPAA": "PG-13",
                  "VCHIP": "TV-Y",
                  "URL": "http://exam.pl/e/manage/ratings"
                         },
              householdID: "3456",
              userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
              channelID: ["channel-1", "channel-2"]
              }
    }

Im Stammverzeichnis des Objekts befinden sich drei Knoten:

  • aktualisiert: Gibt einen UNIX-Zeitstempel an, der das letzte Mal angibt, dass die Metadaten aktualisiert wurden. Diese Eigenschaft wird beim Generieren der Metadaten während der Authentifizierungsphase zunächst vom Server festgelegt. Nachfolgende Aufrufe (nachdem die Metadaten aktualisiert wurden) führen zu einem inkrementierten Zeitstempel.
  • data: enthält die tatsächlichen Metadatenwerte.
  • verschlüsselt: ein Array, das die verschlüsselten Eigenschaften auflistet. Um einen bestimmten Metadatenwert zu entschlüsseln, muss der Programmierer eine Base64-Dekodierung für die Metadaten durchführen und dann eine RSA-Entschlüsselung auf den resultierenden Wert anwenden. Dabei muss er den eigenen privaten Schlüssel verwenden (Adobe verschlüsselt die Metadaten auf dem Server mithilfe des öffentlichen Zertifikats des Programmierers).

Im Fall eines Fehlers gibt der Server ein XML- oder JSON-Objekt zurück, das eine detaillierte Fehlermeldung angibt.

Weitere Informationen finden Sie unter Benutzermetadaten.

Zurück zur REST-API-Referenz

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b