Cette page est spécifique aux Data Landing Zone source connecteur dans Experience Platform. Pour plus d’informations sur la connexion à la variable Data Landing Zone destination connecteur, voir Data Landing Zone page de documentation de destination.
Data Landing Zone est une fonctionnalité sécurisée de stockage de fichiers dans le cloud pour importer des fichiers dans Adobe Experience Platform. Les données sont automatiquement supprimées de la variable Data Landing Zone après sept jours.
Ce tutoriel vous guide tout au long des étapes de création d’un Data Landing Zone connexion source à l’aide de la fonction Flow Service API. Ce tutoriel fournit également des instructions sur la manière de récupérer votre Data Landing Zone, ainsi que d’afficher et d’actualiser vos informations d’identification.
Ce guide nécessite une compréhension professionnelle des composants suivants d’Experience Platform :
Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour créer une Data Landing Zone connexion source à l’aide de la fonction Flow Service API.
Ce tutoriel nécessite également que vous lisiez le guide sur Prise en main des API Platform pour apprendre à s’authentifier auprès des API de Platform et interpréter les exemples d’appels fournis dans la documentation.
La première étape de l’utilisation des API pour accéder à Data Landing Zone est d’effectuer une requête de GET à la variable /landingzone
point d’entrée du Connectors API lors de la fourniture type=user_drop_zone
dans l’en-tête de votre requête.
Format d’API
GET /data/foundation/connectors/landingzone?type=user_drop_zone
En-têtes | Description |
---|---|
user_drop_zone |
Le user_drop_zone type permet à l’API de distinguer un conteneur de zone d’entrée des autres types de conteneurs disponibles. |
Requête
La requête suivante récupère une zone d’entrée existante.
curl -X GET \
'https://platform.adobe.io/data/foundation/connectors/landingzone?type=user_drop_zone' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json'
Réponse
La réponse suivante renvoie des informations sur une zone d’entrée, y compris sur la zone correspondante. containerName
et containerTTL
.
{
"containerName": "dlz-user-container",
"containerTTL": "7"
}
Propriété | Description |
---|---|
containerName |
Nom de la zone d’entrée que vous avez récupérée. |
containerTTL |
Délai d’expiration (en jours) appliqué à vos données dans la zone d’entrée. Tout ce qui se trouve dans une zone d’entrée donnée est supprimé au bout de sept jours. |
Pour récupérer les informations d’identification d’un Data Landing Zone, effectuez une requête de GET à la fonction /credentials
point d’entrée du Connectors API.
Format d’API
GET /data/foundation/connectors/landingzone/credentials?type=user_drop_zone
Requête
L’exemple de requête suivant récupère les informations d’identification d’une zone d’entrée existante.
curl -X GET \
'https://platform.adobe.io/data/foundation/connectors/landingzone/credentials?type=user_drop_zone' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
Réponse
La réponse suivante renvoie les informations d’identification pour votre zone d’entrée, y compris votre SASToken
et SASUri
, ainsi que la variable storageAccountName
qui correspond au conteneur de votre zone d’entrée.
{
"containerName": "dlz-user-container",
"SASToken": "sv=2020-04-08&si=dlz-ed86a61d-201f-4b50-b10f-a1bf173066fd&sr=c&sp=racwdlm&sig=4yTba8voU3L0wlcLAv9mZLdZ7NlMahbfYYPTMkQ6ZGU%3D",
"storageAccountName": "dlblobstore99hh25i3dflek",
"SASUri": "https://dlblobstore99hh25i3dflek.blob.core.windows.net/dlz-user-container?sv=2020-04-08&si=dlz-ed86a61d-201f-4b50-b10f-a1bf173066fd&sr=c&sp=racwdlm&sig=4yTba8voU3L0wlcLAv9mZLdZ7NlMahbfYYPTMkQ6ZGU%3D"
}
Propriété | Description |
---|---|
containerName |
Nom de votre zone d’entrée. |
SASToken |
Jeton de signature d’accès partagé pour votre zone d’entrée. Cette chaîne contient toutes les informations nécessaires pour autoriser une requête. |
SASUri |
URI de signature d’accès partagé pour votre zone d’entrée. Cette chaîne est une combinaison de l’URI de la zone d’entrée pour laquelle vous êtes authentifié et de son jeton SAS correspondant, |
Vous pouvez mettre à jour votre SASToken
en envoyant une requête de POST à la variable /credentials
point d’entrée du Connectors API.
Format d’API
POST /data/foundation/connectors/landingzone/credentials?type=user_drop_zone&action=refresh
En-têtes | Description |
---|---|
user_drop_zone |
Le user_drop_zone type permet à l’API de distinguer un conteneur de zone d’entrée des autres types de conteneurs disponibles. |
refresh |
Le refresh vous permet de réinitialiser les informations d’identification de votre zone d’entrée et de générer automatiquement une nouvelle SASToken . |
Requête
La requête suivante met à jour les informations d’identification de votre zone d’entrée.
curl -X POST \
'https://platform.adobe.io/data/foundation/connectors/landingzone/credentials?type=user_drop_zone&action=refresh' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
Réponse
La réponse suivante renvoie les valeurs mises à jour pour votre SASToken
et SASUri
.
{
"containerName": "dlz-user-container",
"SASToken": "sv=2020-04-08&si=dlz-9c4d03b8-a6ff-41be-9dcf-20123e717e99&sr=c&sp=racwdlm&sig=JbRMoDmFHQU4OWOpgrKdbZ1d%2BkvslO35%2FXTqBO%2FgbRA%3D",
"storageAccountName": "dlblobstore99hh25i3dflek",
"SASUri": "https://dlblobstore99hh25i3dflek.blob.core.windows.net/dlz-user-container?sv=2020-04-08&si=dlz-9c4d03b8-a6ff-41be-9dcf-20123e717e99&sr=c&sp=racwdlm&sig=JbRMoDmFHQU4OWOpgrKdbZ1d%2BkvslO35%2FXTqBO%2FgbRA%3D"
}
Vous pouvez explorer la structure des fichiers et le contenu de votre zone d’entrée en adressant une demande de GET au connectionSpecs
point d’entrée du Flow Service API.
Format d’API
GET /connectionSpecs/{CONNECTION_SPEC_ID}/explore?objectType=root
Paramètre | Description |
---|---|
{CONNECTION_SPEC_ID} |
Identifiant de spécification de connexion qui correspond à Data Landing Zone. Cet ID fixe est 26f526f2-58f4-4712-961d-e41bf1ccc0e8 . |
Requête
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connectionSpecs/26f526f2-58f4-4712-961d-e41bf1ccc0e8/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie un tableau de fichiers et de dossiers trouvés dans le répertoire interrogé. Prenez note de la path
du fichier que vous souhaitez charger, car vous devez le fournir à l’étape suivante pour examiner sa structure.
[
{
"type": "file",
"name": "account.csv",
"path": "dlz-user-container/account.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "data8.csv",
"path": "dlz-user-container/data8.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "folder",
"name": "userdata1",
"path": "dlz-user-container/userdata1/",
"canPreview": false,
"canFetchSchema": false
}
]
Pour inspecter la structure d’un fichier dans votre zone d’entrée, effectuez une requête de GET tout en fournissant le chemin d’accès du fichier et saisissez comme paramètre de requête.
Format d’API
GET /connectionSpecs/{CONNECTION_SPEC_ID}/explore?objectType=file&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}
Paramètre | Description | Exemple |
---|---|---|
{CONNECTION_SPEC_ID} |
Identifiant de spécification de connexion qui correspond à Data Landing Zone. Cet ID fixe est 26f526f2-58f4-4712-961d-e41bf1ccc0e8 . |
|
{OBJECT_TYPE} |
Type de l’objet auquel vous souhaitez accéder. | file |
{OBJECT} |
Chemin et nom de l’objet auquel vous souhaitez accéder. | dlz-user-container/data8.csv |
{FILE_TYPE} |
Type du fichier. |
|
{PREVIEW} |
Une valeur boolean qui définit si l’aperçu du fichier est pris en charge. | true false |
Requête
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connectionSpecs/26f526f2-58f4-4712-961d-e41bf1ccc0e8/explore?objectType=file&object=dlz-user-container/data8.csv&fileType=delimited&preview=true' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie la structure du fichier interrogé, y compris les noms de fichier et les types de données.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "FirstName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "LastName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Email",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Phone",
"type": "string",
"xdm": {
"type": "string"
}
}
]
},
"data": [
{
"Email": "rsmith@abc.com",
"FirstName": "Richard",
"Phone": "111111111",
"Id": "12345",
"LastName": "Smith"
},
{
"Email": "morgan@bac.com",
"FirstName": "Morgan",
"Phone": "22222222222",
"Id": "67890",
"LastName": "Hart"
}
]
}
determineProperties
pour détecter automatiquement les informations de propriété de fichier d’une Data Landing ZoneVous pouvez utiliser la variable determineProperties
pour détecter automatiquement les informations de propriété du contenu du fichier de votre Data Landing Zone lors d’un appel de GET pour explorer le contenu et la structure de votre source.
determineProperties
cas d’utilisationLe tableau suivant décrit les différents scénarios que vous pouvez rencontrer lors de l’utilisation de la variable determineProperties
paramètre de requête ou en fournissant manuellement des informations sur votre fichier.
determineProperties |
queryParams |
Réponse |
---|---|---|
True | S/O | If determineProperties est fourni en tant que paramètre de requête, puis la détection des propriétés du fichier se produit et la réponse renvoie un nouveau properties clé contenant des informations sur le type de fichier, le type de compression et le délimiteur de colonne. |
S/O | True | Si les valeurs du type de fichier, du type de compression et du délimiteur de colonne sont fournies manuellement dans la variable queryParams , elles sont ensuite utilisées pour générer le schéma et les mêmes propriétés sont renvoyées dans le cadre de la réponse. |
True | True | Si les deux options sont effectuées simultanément, une erreur est renvoyée. |
S.O. | S.O. | Si aucune des deux options n’est fournie, une erreur est renvoyée, car il n’existe aucun moyen d’obtenir les propriétés de la réponse. |
Format d’API
GET /connectionSpecs/{CONNECTION_SPEC_ID}/explore?objectType=file&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&determineProperties=true
Paramètre | Description | Exemple |
---|---|---|
determineProperties |
Ce paramètre de requête permet à la variable Flow Service API permettant de détecter des informations concernant les propriétés de votre fichier, notamment des informations sur le type de fichier, le type de compression et le délimiteur de colonne. | true |
Requête
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs/26f526f2-58f4-4712-961d-e41bf1ccc0e8/explore?objectType=file&object=dlz-user-container/garageWeek/file1&preview=true&determineProperties=true' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie la structure du fichier interrogé, y compris les noms de fichier et les types de données, ainsi qu’un properties
clé, contenant des informations sur fileType
, compressionType
, et columnDelimiter
.
{
"properties": {
"fileType": "delimited",
"compressionType": "tarGzip",
"columnDelimiter": "~"
},
"format": "flat",
"schema": {
"columns": [
{
"name": "id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "firstName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "lastName",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "email",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "birthday",
"type": "string",
"xdm": {
"type": "string"
}
}
]
},
"data": [
{
"birthday": "1313-0505-19731973",
"firstName": "Yvonne",
"lastName": "Thilda",
"id": "100",
"email": "Yvonne.Thilda@yopmail.com"
},
{
"birthday": "1515-1212-19731973",
"firstName": "Mary",
"lastName": "Pillsbury",
"id": "101",
"email": "Mary.Pillsbury@yopmail.com"
},
{
"birthday": "0505-1010-19751975",
"firstName": "Corene",
"lastName": "Joeann",
"id": "102",
"email": "Corene.Joeann@yopmail.com"
},
{
"birthday": "2727-0303-19901990",
"firstName": "Dari",
"lastName": "Greenwald",
"id": "103",
"email": "Dari.Greenwald@yopmail.com"
},
{
"birthday": "1717-0404-19651965",
"firstName": "Lucy",
"lastName": "Magdalen",
"id": "199",
"email": "Lucy.Magdalen@yopmail.com"
}
]
}
Propriété | Description |
---|---|
properties.fileType |
Le type de fichier correspondant au fichier interrogé. Les types de fichiers pris en charge sont les suivants : delimited , json , et parquet . |
properties.compressionType |
Type de compression correspondant utilisé pour le fichier interrogé. Les types de compression pris en charge sont les suivants :
|
properties.columnDelimiter |
Délimiteur de colonne correspondant utilisé pour le fichier interrogé. Toute valeur de caractère unique est un délimiteur de colonne autorisé. La valeur par défaut est une virgule. (,) . |
Une connexion source crée et gère la connexion à la source externe à partir de laquelle les données sont ingérées. Une connexion source se compose d’informations telles que la source de données, le format de données et l’identifiant de connexion source nécessaires à la création d’un flux de données. Une instance de connexion source est spécifique à un client et à une organisation.
Pour créer une connexion source, envoyez une requête POST au point d’entrée /sourceConnections
de l’API Flow Service.
Format d’API
POST /sourceConnections
Requête
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Data Landing Zone source connection",
"data": {
"format": "delimited"
},
"params": {
"path": "dlz-user-container/data8.csv"
},
"connectionSpec": {
"id": "26f526f2-58f4-4712-961d-e41bf1ccc0e8",
"version": "1.0"
}
}'
Propriété | Description |
---|---|
name |
Le nom de votre Data Landing Zone connexion source. |
data.format |
Le format des données que vous souhaitez importer dans Platform. |
params.path |
Le chemin d’accès au fichier que vous souhaitez apporter à Platform. |
connectionSpec.id |
Identifiant de spécification de connexion qui correspond à Data Landing Zone. Cet ID fixe est 26f526f2-58f4-4712-961d-e41bf1ccc0e8 . |
Réponse
Une réponse réussie renvoie l’identifiant unique (id
) de la nouvelle connexion source. Le tutoriel suivant requiert cet ID pour créer un flux de données.
{
"id": "f5b46949-8c8d-4613-80cc-52c9c039e8b9",
"etag": "\"1400d460-0000-0200-0000-613be3520000\""
}
En suivant ce tutoriel, vous avez récupéré votre Data Landing Zone informations d’identification, explorez sa structure de fichiers pour trouver le fichier que vous souhaitez importer dans Platform, et créez une connexion source pour commencer à importer vos données dans Platform. Vous pouvez maintenant passer au tutoriel suivant, dans lequel vous apprendrez à créez un flux de données pour importer des données de stockage dans le cloud vers Platform à l’aide de la variable Flow Service API.