DokumentationAdobe PassAdobe Pass-autentisering

Användarmetadata user-metadata

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.
NOTE
REST API-implementeringen begränsas av Begränsningsmekanismen

REST API-slutpunkter clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Beskrivning description

Hämta metadata som MVPD delade om den autentiserade användaren.

Slutpunkt
Anropat
av
Indata
Parametrar
HTTP
Metod
Svar
HTTP
Response
<SP_FQDN>/api/v1/tokens/usermetadata
Direktuppspelande app

eller

Programmeringtjänst
1. beställare
2. deviceId (obligatoriskt)
3. device_info/X-Device-Info (obligatoriskt)
4. deviceType
5. deviceUser (deprecated)
6. appId (utgått)
GET
XML eller JSON som innehåller användarmetadata eller felinformation om det misslyckas.

200 - lyckades

404 - Inga metadata hittades

412 - Ogiltig AuthN-token (t.ex. utgången token)

Indataparameter
Beskrivning
begärande
Programmerarens requestId som den här åtgärden är giltig för.
deviceId
Byte för enhets-ID.

device_info/

X-Device-Info

Information om direktuppspelningsenhet.

Obs! Det här kan skickas device_info som en URL-parameter, men på grund av parameterns potentiella storlek och begränsningar i längden på en GET-URL, bör det skickas som X-Device-Info i http-huvudet.

Se de fullständiga detaljerna i Skicka information om enheter och anslutningar.
deviceType
Enhetstypen (t.ex. Roku, PC).

Om den här parametern är korrekt har ESM värden som är nedbrutna per enhetstyp när Clientless används, så att olika typer av analyser kan utföras för t.ex. Roku, AppleTV, Xbox osv.

Se Fördelar med att använda parameter för enhetstyp utan klient i mätvärden för pass

Obs! device_info ersätter den här parametern.
deviceUser
Enhetens användaridentifierare.

Obs! Om det används bör deviceUser ha samma värden som i begäran Skapa registreringskod.
appId
Program-ID/namn.

Obs! device_info ersätter den här parametern. Om det används ska appId ha samma värden som i begäran Skapa registreringskod.
NOTE
Användarmetadatainformation ska vara tillgänglig när autentiseringsflödet har slutförts, men kan uppdateras i auktoriseringsflödet beroende på MVPD och på metadatatypen.

Exempelsvar sample-response

Efter ett lyckat anrop kommer servern att svara med ett XML- (standard) eller JSON-objekt med en struktur som liknar den som visas nedan:

    {
        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"]
              }
    }

I objektets rot finns det tre noder:

  • uppdaterad: anger en UNIX-tidsstämpel som representerar den senaste gången metadata uppdaterades. Den här egenskapen ställs in från början av servern när metadata genereras under autentiseringsfasen. Efterföljande anrop (efter att metadata har uppdaterats) resulterar i en inkrementell tidsstämpel.
  • data: innehåller de faktiska metadatavärdena.
  • krypterad: en array med de krypterade egenskaperna. Om du vill dekryptera ett specifikt metadatavärde måste programmeraren utföra en Base64-avkodning på metadata och sedan tillämpa en RSA-dekryptering på resultatvärdet med hjälp av dess egen privata nyckel (Adobe krypterar metadata på servern med programmerarens offentliga certifikat).

Om ett fel inträffar returnerar servern ett XML- eller JSON-objekt som anger ett detaljerat felmeddelande.

Mer information finns i Användarmetadata.

Tillbaka till REST API-referens

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