Flow Service est utilisée pour collecter et centraliser les données client provenant de diverses sources disparates à Adobe Experience Platform. Le service fournit une interface utilisateur et une API RESTful à partir de laquelle toutes les sources prises en charge sont connectables.
Ce didacticiel utilise l'API Flow Service pour explorer les systèmes de publicité.
Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
Les sections suivantes fournissent des informations supplémentaires dont vous aurez besoin pour vous connecter à un système publicitaire à l'aide de l'API Flow Service.
Ce didacticiel nécessite que vous disposiez d’une connexion valide avec l’application de publicité tierce à partir de laquelle vous souhaitez importer des données. Une connexion valide implique l'ID de spécification de connexion et l'ID de connexion de votre application. Pour plus d'informations sur la création d'une connexion publicitaire et la récupération de ces valeurs, consultez le didacticiel Connexion d'une source publicitaire à Platform.
Ce tutoriel fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels d’API, voir la section concernant la lecture d’exemples d’appels d’API dans le guide de dépannageExperience Platform.
Pour lancer des appels aux API Platform, vous devez d’abord suivre le tutoriel d’authentification. Le tutoriel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’API Experience Platform, comme indiqué ci-dessous :
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Toutes les ressources de Experience Platform, y compris celles appartenant à Flow Service, sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes d'API Platform nécessitent un en-tête spécifiant le nom du sandbox dans lequel l'opération aura lieu :
x-sandbox-name: {SANDBOX_NAME}
Toutes les requêtes qui contiennent un payload (POST, PUT, PATCH) nécessitent un en-tête de type de média supplémentaire :
Content-Type: application/json
La connexion de base de votre système publicitaire vous permet d’explorer vos tableaux de données en exécutant des requêtes de GET. Utilisez l'appel suivant pour trouver le chemin de la table que vous souhaitez inspecter ou assimiler dans Platform.
Format d’API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Paramètre | Description |
---|---|
{BASE_CONNECTION_ID} |
ID de la connexion de base de votre système publicitaire. |
Requête
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/2484f2df-c057-4ab5-84f2-dfc0577ab592/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse positive est un ensemble de tables de votre système publicitaire. Recherchez la table que vous souhaitez importer dans Platform et notez sa propriété path
, car vous devez la fournir à l'étape suivante pour inspecter sa structure.
[
{
"type": "table",
"name": "v201809.ACCOUNT_PERFORMANCE_REPORT",
"path": "v201809.ACCOUNT_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.ADGROUP_PERFORMANCE_REPORT",
"path": "v201809.ADGROUP_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.AD_CUSTOMIZERS_FEED_ITEM_REPORT",
"path": "v201809.AD_CUSTOMIZERS_FEED_ITEM_REPORT",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "v201809.AD_PERFORMANCE_REPORT",
"path": "v201809.AD_PERFORMANCE_REPORT",
"canPreview": true,
"canFetchSchema": true
}
]
Pour inspecter la structure d'une table à partir de votre système publicitaire, effectuez une demande de GET tout en spécifiant le chemin d'une table en tant que paramètre de requête.
Format d’API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Paramètre | Description |
---|---|
{BASE_CONNECTION_ID} |
ID de connexion de votre système publicitaire. |
{TABLE_PATH} |
Chemin d’accès d’un tableau dans votre système publicitaire. |
Requête
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/2484f2df-c057-4ab5-84f2-dfc0577ab592/explore?objectType=table&object=v201809.AD_PERFORMANCE_REPORT' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie la structure d’un tableau. Les détails relatifs à chacune des colonnes du tableau se trouvent dans les éléments du tableau columns
.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "CallOnlyPhoneNumber",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "AdGroupId",
"type": "long",
"xdm": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
}
},
{
"name": "AdGroupName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Date",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
]
}
}
En suivant ce tutoriel, vous avez exploré votre système publicitaire, trouvé le chemin du tableau que vous souhaitez amener à Platform, et obtenu des informations sur sa structure. Vous pouvez utiliser ces informations dans le didacticiel suivant pour collecter les données de votre système publicitaire et les importer dans Platform.