Partager via

Service d’attribut

Vue d’ensemble

L’API et les services Yield Analytics sont exposés via une interface REST. Il est destiné à faciliter le développement de fonctionnalités personnalisées aux développeurs expérimentés avec les plateformes de développement web 2.0, AJAX, REST et orientées service. Les développeurs doivent être familiarisés avec les paradigmes d’application web, notamment AJAX, XML, JSON et le protocole HTTP(S) avant de tenter de développer avec l’API et les services Yield Analytics.

Le service d’attribut expose actuellement les interfaces liées aux éléments suivants :

  • Création d’une traduction d’attributs
  • Recherche de traduction d’attributs

Types de contenu

L’API REST de service est actuellement conçue pour prendre en charge le type de contenu suivant :

  • JSON - utilisation de Content-type: application/json

La sélection du type de contenu souhaité est un choix que le développeur d’API doit faire au cas par cas. La fonctionnalité d’API est symétrique entre les types de contenu. Les développeurs d’API peuvent spécifier le type de contenu souhaité dans les paramètres de la méthode HTTP GET ou POST ou via leur bibliothèque de client AJAX ou HTTP.

Vérification des erreurs et codes status

Les développeurs d’API doivent case activée les codes de réponse HTTP retournés par l’API REST du service pour détecter les erreurs propagées à partir des appels d’API. Les appels réussis au service entraînent l’utilisation de 200 codes de réponse de plage. Les réponses HTTP de plage 400 et 500 indiquent des erreurs. Les codes de réponse et le texte spécifiques seront probablement modifiés pendant le développement BÊTA de l’API, mais pas les plages.

Sécurité

L’API de service expose les données d’application de manière sécurisée. L’utilisation des fonctionnalités d’API est limitée aux utilisateurs authentifiés et est exposée via des protocoles de transport sécurisés. L’accès à l’API doit avoir lieu dans le contexte suivant :

  • Exemple d’authentification cURL

    L’authentification se produit en transmettant des informations d’identification via des en-têtes HTTP sur chaque requête.

    - username: curl -H "username:username"
- password: curl -H "password:password"
- source: curl -H "source:client_id"

  • Exemple d’authentification HTTPS

    GET /api/v1/rest/
HTTPS/1.1
Host: yieldanalytics.xandr.com
Accept: application/xml, application/json
Content-Type: application/json
username: {{username}}
password: {{password}}
source: {{client_id}}

  • Exemple d’authentification POSTMAN

    Recherchez un exemple de paramètres d’en-tête dans Postman ci-dessous :

    Remarque

    • 'Authorization' est défini sur « No Auth » ; Les paramètres ci-dessous doivent être placés sous l’onglet « En-têtes ».
    • Pour obtenir un didacticiel plus approfondi sur l’utilisation de Postman, consultez Utilisation de Postman avec l’API Yield Analytics.

    Capture d’écran de l’onglet En-têtes avec des clés et des valeurs standard dans Postman.

Confidentialité

La confidentialité est maintenue à l’aide de la communication basée sur la couche de sockets sécurisés pour interagir avec l’API Yield Analytics. Les développeurs d’API doivent préférer l’utilisation du protocole HTTPS à la communication http non sécurisée dans la mesure du possible. Consultez votre bibliothèque cliente HTTP pour savoir comment activer HTTP sur SSL lors du développement en dehors d’un contexte de navigateur web.

Paths

Convertir des ID externes en lexique d’expression Yield Analytics

POST /api/v1/rest/attributes/convert

  • Description

    Transmettez des ID externes pour l’attribut et la ou les valeurs d’attribut afin de les convertir en lexique de ciblage Yield Analytics.

  • Paramètres

    Type Nom Description Obligatoire Schéma Par défaut
    BodyParameter attributeConverter attributeConverter true AttributeConverter N/A
    HeaderParameter username Votre nom d’utilisateur pour accéder à l’API Yield Analytics true string N/A
    HeaderParameter mot de passe Votre mot de passe pour accéder à l’API Yield Analytics true string N/A
    HeaderParameter source Votre source cliente pour accéder à l’API Yield Analytics true string N/A

  • Réponses

    HTTP Code Description Schéma
    200 OK StringResponse

  • Consomme

    application/json

  • Produit

    application/json

  • Tags

    Ressource d’attribut

  • Exemple de demande cURL

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/attributes/create' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}' -d '{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}'

  • Exemple de requête HTTP

    POST /api/v1/rest/attributes/create HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest
Content-Length: 235

{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}

  • Exemple de réponse HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
"result" : "Created"
}

Create nouvelle traduction d’attributs

POST /api/v1/rest/attributes/create

  • Description

    Cela accepte uniquement un fichier au format JSON, l’analyse et crée un attribut dans la base de données Yield Analytics.

  • Paramètres

    Type Nom Description Obligatoire Schéma Par défaut
    BodyParameter Attributetranslation Attributetranslation true Attributetranslation N/A
    HeaderParameter username Votre nom d’utilisateur pour accéder à l’API Yield Analytics true string N/A
    HeaderParameter mot de passe Votre mot de passe pour accéder à l’API Yield Analytics true string N/A
    HeaderParameter source Votre source cliente pour accéder à l’API Yield Analytics true string N/A

  • Réponses

    HTTP Code Description Schéma
    200 OK StringResponse

  • Consomme

    application/json

  • Produit

    application/json

  • Tags

    Ressource d’attribut

  • Exemple de demande cURL

    $ curl 'https://{{client_url}}/api/v1/rest/v1/rest/attributes/create' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'username: {{username}}' -H 'password: {{password}}' -H 'source: {{source}}' -d '{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}'

  • Exemple de requête HTTP

    POST /api/v1/rest/attributes/create HTTP/1.1
Content-Type: application/json
Accept: application/json
username: {{username}}
password: {{password}}
source: {{source}}
Host: https://{{client_url}}/api/v1/rest
Content-Length: 235

{
"attributeTranslation" : {
"inputAttribute" : "attribute1",
"inputValue" : "value1",
"targetAttribute" : "targetattribute1",
"targetValue" : "targetValue1",
"adServerType" : "XFP",
"invincible" : false
}
}

  • Exemple de réponse HTTP

    HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
"result" : "Created"
}

Définitions

AttributeConverter

Nom Description Obligatoire Schéma
attributeConverter false AttributeConverter
Attributename Nom de l’attribut true string
dfpTargetingIds ID DFP séparés par des virgules à traduire. true string
opérateur Opérateur Inclusion ou Exclusion. true string

Attributetranslation

Nom Description Obligatoire Schéma
adServerType Type adServer de la traduction d’attributs true chaîne
Attributetranslation Attributetranslation
inputAttribute Attribut d’entrée de la traduction d’attributs true string
inputValue Valeur d’entrée de la traduction d’attribut true string
Invincible Champ invincible de la traduction d’attributs true valeur booléenne
targetAttribute Attribut cible de la traduction d’attributs true chaîne
targetValue Valeur cible de la traduction d’attribut true string

StringResponse

Objet JSON pour contenir les résultats de chaîne des requêtes API.

Nom Description Obligatoire Schéma
result Résultat de l’opération. true string

Yield Analytics API

  • Last updated on