Ce tutoriel vous guide tout au long des étapes de connexion de Google PubSub (ci-après dénommé « PubSub ») à Experience Platform à l’aide de l’API Flow Service .
Ce guide nécessite une compréhension professionnelle des composants suivants d’Adobe Experience Platform :
Les sections suivantes contiennent des informations supplémentaires que vous devez connaître pour réussir à connecter PubSub à Platform à l’aide de l’API Flow Service.
Pour que Flow Service puisse se connecter à PubSub, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification | Description |
---|---|
projectId |
Identifiant de projet requis pour authentifier PubSub. |
credentials |
Informations d’identification ou clé requises pour authentifier PubSub. |
connectionSpec.id |
La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base cibles et sources. L’identifiant de spécification de connexion PubSub est : 70116022-a743-464a-bbfe-e226a7f8210c . |
Pour plus d’informations sur ces valeurs, voir le document d’PubSub authentification. Pour utiliser l’authentification par compte de service, consultez le PubSub Guide de création de comptes de service pour savoir comment générer vos informations d’identification.
Si vous utilisez l’authentification par compte de service, assurez-vous que vous avez accordé un accès utilisateur suffisant à votre compte de service et qu’il n’y a pas d’espaces blancs supplémentaires dans le fichier JSON lors de la copie et du collage de vos informations d’identification.
Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.
La première étape de création d’une connexion source consiste à authentifier votre source PubSub et à générer un identifiant de connexion de base. Un identifiant de connexion de base vous permet d’explorer et de parcourir les fichiers de votre source et d’identifier les éléments spécifiques à ingérer, y compris des informations concernant leurs types et formats de données.
Pour créer un identifiant de connexion de base, envoyez une requête POST au point d’entrée /connections
lors de la fourniture des informations d’identification d’authentification PubSub dans le cadre des paramètres de requête.
Format d’API
POST /connections
Requête
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "Google PubSub connection",
"description": "Google PubSub connection",
"auth": {
"specName": "Google PubSub authentication credentials",
"params": {
"projectId": "{PROJECT_ID}",
"credentials": "{CREDENTIALS}"
}
},
"connectionSpec": {
"id": "70116022-a743-464a-bbfe-e226a7f8210c",
"version": "1.0"
}
}'
Propriété | Description |
---|---|
auth.params.projectId |
Identifiant de projet requis pour authentifier PubSub. |
auth.params.credentials |
Informations d’identification ou clé requises pour authentifier PubSub. |
connectionSpec.id |
L’identifiant de spécification de connexion PubSub : 70116022-a743-464a-bbfe-e226a7f8210c . |
Réponse
Une réponse réussie renvoie les détails de la connexion nouvellement créée, y compris son identifiant unique (id
). Cet identifiant de connexion de base est requis à l’étape suivante pour créer une connexion source.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
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 un 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 IMS.
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 'content-type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "Google PubSub source connection",
"description": "A source connection for Google PubSub",
"baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
"connectionSpec": {
"id": "70116022-a743-464a-bbfe-e226a7f8210c",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"topicId": "{TOPIC_ID}",
"subscriptionId": "{SUBSCRIPTION_ID}",
"dataType": "raw"
}
}'
Propriété | Description |
---|---|
name |
Nom de votre connexion source. Assurez-vous que le nom de votre connexion source est descriptif, car vous pouvez l’utiliser pour rechercher des informations sur votre connexion source. |
description |
Valeur facultative que vous pouvez fournir pour inclure plus d’informations sur votre connexion source. |
baseConnectionId |
Identifiant de connexion de base de votre source PubSub générée à l’étape précédente. |
connectionSpec.id |
Identifiant de spécification de connexion fixe pour PubSub. Cet ID est le suivant : 70116022-a743-464a-bbfe-e226a7f8210c . |
data.format |
Format des données PubSub que vous souhaitez ingérer. Actuellement, le format de données json est le seul à être pris en charge. |
params.topicId |
L’ID de sujet définit la ressource nommée spécifique dont les messages sont envoyés par les éditeurs. |
params.subscriptionId |
L’ID d’abonnement définit la ressource nommée spécifique qui représente le flux de messages d’un sujet unique spécifique à diffuser à l’application avec abonnement. |
params.dataType |
Ce paramètre définit le type des données ingérées. Les types de données pris en charge sont les suivants : raw et xdm . |
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": "e96d6135-4b50-446e-922c-6dd66672b6b2",
"etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}
Ce tutoriel vous a permis de créer une connexion source PubSub à l’aide de l’API Flow Service. Vous pouvez utiliser cet ID de connexion source dans le tutoriel suivant pour créer un flux de données en continu à l’aide de l’API Flow Service .