DokumentationAdobe PassAdobe Pass-Authentifizierung

(Veraltete) Benutzermetadaten user-metadata

Last update: Wed Jan 29 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Der Inhalt dieser Seite dient nur zu Informationszwecken. Die Verwendung dieser API erfordert eine aktuelle Lizenz von Adobe. Eine unbefugte Nutzung ist nicht zulässig.
IMPORTANT
Achten Sie darauf, über die neuesten Ankündigungen zu Produkten der Adobe Pass-Authentifizierung und Stilllegungszeitpläne auf der Seite Produktankündigungen auf dem Laufenden zu bleiben.
NOTE
Die REST-API-Implementierung wird durch Drosselungsmechanismus)

REST-API-Endpunkte clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Beschreibung description

Rufen Sie Metadaten ab, die MVPD über den authentifizierten Benutzer freigegeben hat.

Endpunkt
Called
by
Eingabe
Parameter
HTTP
Methode
Antwort
HTTP
Antwort
<SP_FQDN>/api/v1/tokens/usermetadata
Streaming-App

oder

Programmierer-Service
1. Antragsteller
2. deviceId (obligatorisch)
3. device_info/X-device-info (obligatorisch)
4. deviceType
5. deviceUser (veraltet)
6. appId (veraltet)
GET
XML oder JSON mit Benutzermetadaten oder Fehlerdetails, falls nicht erfolgreich.

200 - Erfolg

404 - Keine Metadaten gefunden

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

Eingabeparameter
Beschreibung
Antragsteller
Die RequestorId des Programmierers, für den dieser Vorgang gültig ist.
deviceId
Die Geräte-ID-Bytes.

device_info/

x-device-info

Informationen zu Streaming-Geräten.

Hinweis: Dies kann als URL-Parameter an device_info übergeben werden, sollte jedoch aufgrund der potenziellen Größe dieses Parameters und der Längenbeschränkungen für eine GET-URL als X-Device-Info im HTTP-Header übergeben werden.

Details finden Sie unter Übergeben von Geräte- und Verbindungsinformationen.
deviceType
Der Gerätetyp (z. B. Roku, PC).

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

Siehe Vorteile der Verwendung von Client-losen Gerätetypparametern in Kennzahlen für

Hinweis: Der device_info ersetzt diesen Parameter.
deviceUser
Die Geräte-Benutzerkennung.

Hinweis: Wenn verwendet, sollten deviceUser dieselben Werte wie in der Anfrage Registrierungs-Code erstellen haben.
appId
Die Anwendungs-ID/-name.

Hinweis: Der device_info ersetzt diesen Parameter. Wenn verwendet, sollten appId dieselben Werte wie in der Anfrage Registrierungs-Code erstellen haben.
NOTE
Informationen zu Benutzermetadaten sollten nach Abschluss des Authentifizierungsflusses verfügbar sein, können jedoch je nach MVPD und Metadatentyp im Autorisierungsfluss aktualisiert werden.

Beispielantwort sample-response

Nach einem erfolgreichen Aufruf antwortet der Server mit einem XML- (Standard) oder JSON-Objekt mit einer ähnlichen Struktur wie der unten gezeigten:

    {
        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 darstellt, dass die Metadaten aktualisiert wurden. Diese Eigenschaft wird zunächst vom Server beim Generieren der Metadaten während der Authentifizierungsphase festgelegt. Nachfolgende Aufrufe (nachdem die Metadaten aktualisiert wurden) führen zu einem inkrementellen Zeitstempel.
  • data: enthält die tatsächlichen Metadatenwerte.
  • Encrypted: Ein Array, das die verschlüsselten Eigenschaften auflistet. Um einen bestimmten Metadatenwert zu entschlüsseln, muss der Programmierer eine Base64-Decodierung der Metadaten durchführen und dann eine RSA-Entschlüsselung auf den resultierenden Wert anwenden, indem er seinen eigenen privaten Schlüssel verwendet (Adobe verschlüsselt die Metadaten auf dem Server mithilfe des öffentlichen Zertifikats des Programmierers).

Im Falle 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