Métadonnées utilisateur user-metadata
NOTE
Le contenu de cette page est fourni à titre d’information uniquement. L’utilisation de cette API nécessite une licence actuelle de Adobe. Aucune utilisation non autorisée n’est autorisée.
NOTE
L’implémentation de l’API REST est limitée par Mécanisme de ralentissement
Points de terminaison de l’API REST clientless-endpoints
<REGGIE_FQDN>
:
- Production - api.auth.adobe.com
- Évaluation - api.auth-staging.adobe.com
<SP_FQDN>
:
- Production - api.auth.adobe.com
- Évaluation - api.auth-staging.adobe.com
Description description
Récupérez les métadonnées que MVPD a partagées à propos de l’utilisateur authentifié.
Point d’entrée
Appelé
Par
Par
Entrée
Paramètres
Paramètres
HTTP
Méthode
Méthode
Réponse
HTTP
Réponse
Réponse
<SP_FQDN>
/api/v1/tokens/usermetadataApplication de diffusion en continu
ou
Service de programmation
ou
Service de programmation
1. demandeur
2. deviceId (obligatoire)
3. device_info/X-Device-Info (obligatoire)
4. deviceType
5. deviceUser (obsolète)
6. appId (obsolète)
2. deviceId (obligatoire)
3. device_info/X-Device-Info (obligatoire)
4. deviceType
5. deviceUser (obsolète)
6. appId (obsolète)
GET
XML ou JSON contenant des métadonnées utilisateur ou des détails d’erreur en cas d’échec.
200 - Succès
404 - Aucune métadonnée trouvée
412 - Jeton AuthN non valide (par exemple, jeton expiré)
Paramètre d’entrée
Description
demandeur
Identifiant du demandeur du programmeur pour lequel cette opération est valide.
deviceId
Octets d’identifiant de l’appareil.
device_info/
X-Device-Info
Informations sur les périphériques de diffusion en continu.
Remarque : Il peut s’agir de transférer device_info comme paramètre d’URL, mais en raison de la taille potentielle de ce paramètre et des limitations de longueur d’une URL de GET, il doit être transmis sous la forme X-Device-Info dans l’en-tête http.
Consultez les détails complets de la section Transmission des informations de périphérique et de connexion.
Remarque : Il peut s’agir de transférer device_info comme paramètre d’URL, mais en raison de la taille potentielle de ce paramètre et des limitations de longueur d’une URL de GET, il doit être transmis sous la forme X-Device-Info dans l’en-tête http.
Consultez les détails complets de la section Transmission des informations de périphérique et de connexion.
deviceType
Type d’appareil (par exemple, Roku, PC).
Si ce paramètre est correctement défini, ESM propose des mesures qui sont ventilation par type d’appareil lors de l’utilisation de Clientless, de sorte que différents types d’analyses puissent être effectués pour Roku, Apple TV, Xbox, etc.
Voir Avantages de l’utilisation d’un paramètre de type d’appareil sans client dans les mesures de transmission
Remarque : La variable
Si ce paramètre est correctement défini, ESM propose des mesures qui sont ventilation par type d’appareil lors de l’utilisation de Clientless, de sorte que différents types d’analyses puissent être effectués pour Roku, Apple TV, Xbox, etc.
Voir Avantages de l’utilisation d’un paramètre de type d’appareil sans client dans les mesures de transmission
Remarque : La variable
device_info
remplace ce paramètre.deviceUser
Identifiant de l’utilisateur de l’appareil.
Remarque : En cas d’utilisation,
Remarque : En cas d’utilisation,
deviceUser
doivent avoir les mêmes valeurs que dans la variable Créer un code d’enregistrement requête.appId
ID/nom de l’application.
Remarque : La variable
Remarque : La variable
device_info
remplace ce paramètre. En cas d’utilisation, appId
doivent avoir les mêmes valeurs que dans la variable Créer un code d’enregistrement requête.NOTE
Les informations de métadonnées utilisateur doivent être disponibles une fois le flux d’authentification terminé, mais peuvent être mises à jour sur le flux d’autorisation, en fonction du MVPD et du type de métadonnées.
Exemple de réponse sample-response
Après un appel réussi, le serveur répond avec un objet XML (par défaut) ou JSON avec une structure similaire à celle présentée ci-dessous :
{
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"]
}
}
À la racine de l’objet, il y a trois noeuds :
- mis à jour: spécifie un horodatage UNIX qui représente la dernière fois où les métadonnées ont été mises à jour. Cette propriété est définie initialement par le serveur lors de la génération des métadonnées pendant la phase d’authentification. Les appels suivants (une fois les métadonnées mises à jour) génèrent un horodatage incrémenté.
- data: contient les valeurs réelles des métadonnées.
- encrypted: un tableau répertoriant les propriétés chiffrées. Pour déchiffrer une valeur de métadonnées spécifique, le programmeur doit effectuer un décodage Base64 sur les métadonnées, puis appliquer un déchiffrement RSA sur la valeur obtenue, en utilisant sa propre clé privée (l’Adobe chiffre les métadonnées sur le serveur à l’aide du certificat public du programmeur).
En cas d’erreur, le serveur renvoie un objet XML ou JSON spécifiant un message d’erreur détaillé.
Pour plus d’informations, voir Métadonnées utilisateur.
Retour à la référence de l’API REST
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b