L’esercitazione seguente illustra i passaggi necessari per creare una connessione sorgente e un flusso di dati per Mailchimp Members dati a Platform tramite Flow Service API.
Prima di poterti connettere Mailchimp per Adobe Experience Platform utilizzando il codice di aggiornamento OAuth 2, devi prima recuperare il token di accesso per MailChimp. Consulta la sezione Mailchimp Guida di OAuth 2 per istruzioni dettagliate su come trovare il token di accesso.
Una volta recuperato il Mailchimp credenziali di autenticazione, ora puoi avviare il processo di creazione del flusso di dati per portare Mailchimp Members a Platform. Il primo passaggio nella creazione di un flusso di dati consiste nel creare una connessione di base.
Una connessione di base conserva le informazioni tra l'origine e la piattaforma, incluse le credenziali di autenticazione dell'origine, lo stato corrente della connessione e l'ID di connessione di base univoco. L’ID di connessione di base consente di esplorare e navigare tra i file di origine e di identificare gli elementi specifici da acquisire, comprese le informazioni relative ai tipi di dati e ai formati corrispondenti.
Mailchimp supporta sia l’autenticazione di base che il codice di aggiornamento OAuth 2. Per informazioni su come eseguire l’autenticazione con uno dei due tipi di autenticazione, consulta gli esempi seguenti.
Per creare una Mailchimp connessione di base utilizzando l’autenticazione di base, effettuare una richiesta di POST al /connections
punto finale Flow Service API fornendo le credenziali host
, authorizationTestUrl
, username
e password
.
Formato API
POST /connections
Richiesta
La richiesta seguente crea una connessione di base per Mailchimp:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "Mailchimp base connection with basic authentication",
"description": "Mailchimp Members base connection with basic authentication",
"connectionSpec": {
"id": "2e8580db-6489-4726-96de-e33f5f60295f",
"version": "1.0"
},
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"authorizationTestUrl": "https://login.mailchimp.com/oauth2/metadata",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome della connessione di base. Assicurati che il nome della connessione di base sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione di base. |
description |
(Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione di base. |
connectionSpec.id |
ID della specifica di connessione dell'origine. Questo ID può essere recuperato dopo la registrazione e l'approvazione della sorgente tramite Flow Service API. |
auth.specName |
Tipo di autenticazione utilizzato per collegare l’origine a Platform. |
auth.params.host |
URL principale utilizzato per la connessione a Mailchimp API. Il formato dell’URL principale è https://{DC}.api.mailchimp.com , dove {DC} rappresenta il data center che corrisponde al tuo account. |
auth.params.authorizationTestUrl |
(Facoltativo) L'URL del test di autorizzazione viene utilizzato per convalidare le credenziali durante la creazione di una connessione di base. Se non viene fornito, le credenziali vengono automaticamente controllate durante il passaggio di creazione della connessione di origine. |
auth.params.username |
Il nome utente che corrisponde al tuo Mailchimp conto. Questo è necessario per l’autenticazione di base. |
auth.params.password |
La password che corrisponde alla tua Mailchimp conto. Questo è necessario per l’autenticazione di base. |
Risposta
Una risposta corretta restituisce la nuova connessione di base creata, incluso l'identificatore di connessione univoco (id
). Questo ID è necessario per esplorare la struttura file e il contenuto della tua sorgente nel passaggio successivo.
{
"id": "4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa",
"etag": "\"4000cff7-0000-0200-0000-6154bad60000\""
}
Per creare una Mailchimp connessione di base tramite il codice di aggiornamento OAuth 2, effettuare una richiesta POST al /connections
endpoint durante la fornitura delle credenziali host
, authorizationTestUrl
e accessToken
.
Formato API
POST /connections
Richiesta
La richiesta seguente crea una connessione di base per Mailchimp:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "MailChimp base connection with OAuth 2 refresh code",
"description": "MailChimp Members base connection with OAuth 2 refresh code",
"connectionSpec": {
"id": "2e8580db-6489-4726-96de-e33f5f60295f",
"version": "1.0"
},
"auth": {
"specName": "oAuth2RefreshCode",
"params": {
"host": "{HOST}",
"authorizationTestUrl": "https://login.mailchimp.com/oauth2/metadata",
"accessToken": "{ACCESS_TOKEN}"
}
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome della connessione di base. Assicurati che il nome della connessione di base sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione di base. |
description |
(Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione di base. |
connectionSpec.id |
ID della specifica di connessione dell'origine. Questo ID può essere recuperato dopo la registrazione della sorgente utilizzando Flow Service API. |
auth.specName |
Il tipo di autenticazione utilizzato per autenticare l’origine in Platform. |
auth.params.host |
URL principale utilizzato per la connessione a Mailchimp API. Il formato dell’URL principale è https://{DC}.api.mailchimp.com , dove {DC} rappresenta il data center che corrisponde al tuo account. |
auth.params.authorizationTestUrl |
(Facoltativo) L'URL del test di autorizzazione viene utilizzato per convalidare le credenziali durante la creazione di una connessione di base. Se non viene fornito, le credenziali vengono automaticamente controllate durante il passaggio di creazione della connessione di origine. |
auth.params.accessToken |
Il token di accesso corrispondente utilizzato per autenticare l'origine. Questo è necessario per l’autenticazione basata su OAuth. |
Risposta
Una risposta corretta restituisce la nuova connessione di base creata, incluso l'identificatore di connessione univoco (id
). Questo ID è necessario per esplorare la struttura file e il contenuto della tua sorgente nel passaggio successivo.
{
"id": "4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa",
"etag": "\"4000cff7-0000-0200-0000-6154bad60000\""
}
Utilizzando l’ID di connessione di base generato nel passaggio precedente, puoi esplorare file e directory eseguendo richieste di GET.
Per recuperare il tipo di formato accettato per {SOURCE_PARAMS}
, devi codificare l’intero list_id
stringa in base64. Ad esempio: "list_id": "10c097ca71"
codificato in base64 equivale a eyJsaXN0SWQiOiIxMGMwOTdjYTcxIn0=
.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
Quando si eseguono richieste di GET per esplorare la struttura e il contenuto del file di origine, è necessario includere i parametri di query elencati nella tabella seguente:
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} |
ID connessione di base generato nel passaggio precedente. |
{OBJECT_TYPE} |
Il tipo di oggetto da esplorare. Per le origini REST, il valore predefinito è rest . |
{OBJECT} |
Oggetto da esplorare. |
{FILE_TYPE} |
Questo parametro è necessario solo quando si visualizza una directory specifica. Il suo valore rappresenta il percorso della directory che desideri esplorare. |
{PREVIEW} |
Valore booleano che definisce se il contenuto della connessione supporta l’anteprima. |
{SOURCE_PARAMS} |
Una stringa codificata base64 del tuo list_id . |
Richiesta
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/05c595e5-edc3-45c8-90bb-fcf556b57c4b/explore?objectType=rest&object=json&fileType=json&preview=true&sourceParams=eyJsaXN0SWQiOiIxMGMwOTdjYTcxIn0=' \
-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}'
Risposta
Una risposta corretta restituisce la struttura del file interrogato.
{
"data": [
{
"list_id": "10c097ca71",
"_links": [
{
"rel": "self",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
"schema": "https://us6.api.mailchimp.com/schema/3.0/Paths/Lists/Members/Collection.json"
},
{
"rel": "parent",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
},
{
"rel": "create",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members",
"method": "POST",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
"schema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/POST.json"
}
],
"members": [
{
"id": "cff65fb4c5f5828666ad846443720efd",
"email_address": "kendallt2134@gmail.com",
"unique_email_id": "72c758cbf1",
"contact_id": "874a0d6e9ddb89d8b4a31e416ead2d6f",
"full_name": "Kendall Roy",
"web_id": 547094062,
"email_type": "html",
"status": "subscribed",
"consents_to_one_to_one_messaging": true,
"merge_fields": {
"FNAME": "Kendall",
"LNAME": "Roy",
"ADDRESS": {
"country": "US"
}
},
"stats": {
"avg_open_rate": 0,
"avg_click_rate": 0
},
"ip_opt": "103.43.112.97",
"timestamp_opt": "2021-06-01T15:31:36+00:00",
"member_rating": 2,
"last_changed": "2021-06-01T15:31:36+00:00",
"vip": false,
"location": {
"latitude": 0,
"longitude": 0,
"gmtoff": 0,
"dstoff": 0
},
"source": "Admin Add",
"tags_count": 0,
"list_id": "10c097ca71",
"_links": [
{
"rel": "self",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
},
{
"rel": "parent",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
"schema": "https://us6.api.mailchimp.com/schema/3.0/Paths/Lists/Members/Collection.json"
},
{
"rel": "update",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd",
"method": "PATCH",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
"schema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/PATCH.json"
},
{
"rel": "upsert",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd",
"method": "PUT",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json",
"schema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/PUT.json"
},
{
"rel": "delete",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd",
"method": "DELETE"
},
{
"rel": "activity",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd/activity",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Activity/Response.json"
},
{
"rel": "goals",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd/goals",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Goals/Response.json"
},
{
"rel": "notes",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd/notes",
"method": "GET",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Notes/CollectionResponse.json"
},
{
"rel": "events",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd/events",
"method": "POST",
"targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Events/POST.json"
},
{
"rel": "delete_permanent",
"href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd/actions/delete-permanent",
"method": "POST"
}
]
}
]
}
]
}
È possibile creare una connessione sorgente effettuando una richiesta di POST al Flow Service API. Una connessione di origine è costituita da un ID connessione, un percorso del file di dati di origine e un ID della specifica di connessione.
Per creare una connessione di origine, è inoltre necessario definire un valore enum per l'attributo del formato dati.
Utilizza i seguenti valori enum per le origini basate su file:
Formato dati | Valore Enum |
---|---|
Delimitato | delimited |
JSON | json |
Parquet | parquet |
Per tutte le origini basate su tabella, impostare il valore su tabular
.
Formato API
POST /sourceConnections
Richiesta
La richiesta seguente crea una connessione di origine per Mailchimp:
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": "MailChimp source connection to ingest listId",
"description": "MailChimp Members source connection to ingest listId",
"baseConnectionId": "4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa",
"connectionSpec": {
"id": "2e8580db-6489-4726-96de-e33f5f60295f",
"version": "1.0"
},
"data": {
"format": "json",
},
"params": {
"listId": "10c097ca71"
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome della connessione di origine. Assicurati che il nome della connessione sorgente sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione sorgente. |
description |
(Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione sorgente. |
baseConnectionId |
ID connessione di base di Mailchimp. Questo ID è stato generato in un passaggio precedente. |
connectionSpec.id |
ID della specifica di connessione corrispondente alla tua origine. |
data.format |
Il formato del Mailchimp dati da acquisire. |
params.listId |
Noto anche come ID pubblico , il Mailchimp L’ID elenco consente il trasferimento di dati di pubblico ad altre integrazioni. |
Risposta
Una risposta corretta restituisce l'identificatore univoco (id
) della nuova connessione sorgente creata. Questo ID è necessario in un passaggio successivo per creare un flusso di dati.
{
"id": "a51e4cf6-65ef-45f4-b4bf-4f03da5f01cc",
"etag": "\"6b02b65d-0000-0200-0000-6154bfbe0000\""
}
Affinché i dati di origine possano essere utilizzati in Platform, è necessario creare uno schema di destinazione per strutturare i dati di origine in base alle tue esigenze. Lo schema di destinazione viene quindi utilizzato per creare un set di dati di Platform in cui sono contenuti i dati di origine.
È possibile creare uno schema XDM di destinazione effettuando una richiesta POST al API del Registro di sistema dello schema.
Per i passaggi dettagliati su come creare uno schema XDM di destinazione, consulta l’esercitazione su creazione di uno schema tramite API.
È possibile creare un set di dati di destinazione eseguendo una richiesta di POST al API del servizio catalogo, fornendo l’ID dello schema di destinazione all’interno del payload.
Per i passaggi dettagliati su come creare un set di dati di destinazione, consulta l’esercitazione su creazione di un set di dati tramite API.
Una connessione di destinazione rappresenta la connessione alla destinazione in cui i dati acquisiti arrivano. Per creare una connessione di destinazione, è necessario fornire l’ID di specifica di connessione fissa corrispondente al Data Lake. Questo ID è: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
Ora disponi degli identificatori univoci di uno schema di destinazione di un set di dati di destinazione e dell’ID della specifica di connessione di Data Lake. Utilizzando questi identificatori, puoi creare una connessione di destinazione utilizzando Flow Service API per specificare il set di dati che conterrà i dati di origine in entrata.
Formato API
POST /targetConnections
Richiesta
La seguente richiesta crea una connessione di destinazione per Mailchimp:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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": "MailChimp target connection",
"description": "MailChimp Members target connection",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/570630b91eb9d5cf5db0436756abb110d02912917a67da2d",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "6155e3a9bd13651949515f14"
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome della connessione di destinazione. Assicurati che il nome della connessione di destinazione sia descrittivo, in quanto puoi utilizzarlo per cercare informazioni sulla connessione di destinazione. |
description |
(Facoltativo) Proprietà che è possibile includere per fornire ulteriori informazioni sulla connessione di destinazione. |
connectionSpec.id |
ID della specifica di connessione corrispondente a Data Lake. Questo ID fisso è: c604ff05-7f1a-43c0-8e18-33bf874cb11c . |
data.format |
Il formato del Mailchimp i dati che desideri inserire in Platform. |
params.dataSetId |
ID del set di dati di destinazione recuperato in un passaggio precedente. |
Risposta
Una risposta corretta restituisce l'identificatore univoco della nuova connessione di destinazione (id
). Questo ID è necessario nei passaggi successivi.
{
"id": "8db5fb4a-6ce8-4370-afc0-1765e39535a5",
"etag": "\"960093ce-0000-0200-0000-6154da3e0000\""
}
Affinché i dati di origine possano essere acquisiti in un set di dati di destinazione, devono prima essere mappati sullo schema di destinazione a cui aderisce il set di dati di destinazione. A tal fine, è necessario eseguire una richiesta POST al Data Prep API con mappature dati definite all’interno del payload della richiesta.
Formato API
POST /conversion/mappingSets
Richiesta
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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 '{
"version": 0,
"xdmSchema": "_{TENANT_ID}.schemas.570630b91eb9d5cf5db0436756abb110d02912917a67da2d",
"xdmVersion": "1.0",
"mappings": [
{
"destinationXdmPath": "person.name.firstName",
"sourceAttribute": "merge_fields.FNAME",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "person.name.lastName",
"sourceAttribute": "merge_fields.LNAME",
"identity": false,
"version": 0
}
]
}'
Proprietà | Descrizione |
---|---|
xdmSchema |
ID del schema XDM di destinazione generato in un passaggio precedente. |
mappings.destinationXdmPath |
Percorso XDM di destinazione in cui viene eseguito il mapping dell'attributo di origine. |
mappings.sourceAttribute |
L'attributo di origine che deve essere mappato su un percorso XDM di destinazione. |
mappings.identity |
Un valore booleano che indica se il set di mappatura verrà contrassegnato per Identity Service. |
Risposta
Una risposta corretta restituisce i dettagli della mappatura appena creata, incluso il relativo identificatore univoco (id
). Questo valore è necessario in un passaggio successivo per creare un flusso di dati.
{
"id": "5a365b23962d4653b9d9be25832ee5b4",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
L'ultimo passo verso Mailchimp In Platform viene creato un flusso di dati. A questo punto sono stati preparati i seguenti valori richiesti:
Un flusso di dati è responsabile della pianificazione e della raccolta dei dati da un’origine. È possibile creare un flusso di dati eseguendo una richiesta di POST fornendo al contempo i valori precedentemente menzionati all’interno del payload.
Per pianificare un’acquisizione, è innanzitutto necessario impostare il valore dell’ora di inizio in modo che l’ora di inizio sia espressa in secondi. Quindi, è necessario impostare il valore della frequenza su una delle cinque opzioni: once
, minute
, hour
, day
oppure week
. Il valore dell’intervallo indica il periodo tra due acquisizioni consecutive e la creazione di un’acquisizione una tantum non richiede l’impostazione di un intervallo. Per tutte le altre frequenze, il valore dell'intervallo deve essere impostato su uguale o maggiore di 15
.
Formato API
POST /flows
Richiesta
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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": "MailChimp Members dataflow",
"description": "MailChimp Members dataflow",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"a51e4cf6-65ef-45f4-b4bf-4f03da5f01cc"
],
"targetConnectionIds": [
"8db5fb4a-6ce8-4370-afc0-1765e39535a5"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "5a365b23962d4653b9d9be25832ee5b4",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": "1632809759",
"frequency": "minute",
"interval": 15
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome del flusso di dati. Assicurati che il nome del flusso di dati sia descrittivo in quanto puoi utilizzarlo per cercare informazioni sul flusso di dati. |
description |
(Facoltativo) Proprietà che puoi includere per fornire ulteriori informazioni sul flusso di dati. |
flowSpec.id |
ID delle specifiche di flusso necessario per creare un flusso di dati. Questo ID fisso è: 6499120c-0b15-42dc-936e-847ea3c24d72 . |
flowSpec.version |
Versione corrispondente dell’ID della specifica di flusso. Questo valore predefinito è 1.0 . |
sourceConnectionIds |
La ID connessione di origine generato in un passaggio precedente. |
targetConnectionIds |
La ID connessione di destinazione generato in un passaggio precedente. |
transformations |
Questa proprietà contiene le varie trasformazioni necessarie per essere applicate ai dati. Questa proprietà è necessaria per portare dati non conformi a XDM su Platform. |
transformations.name |
Nome assegnato alla trasformazione. |
transformations.params.mappingId |
La ID mappatura generato in un passaggio precedente. |
transformations.params.mappingVersion |
Versione corrispondente dell'ID di mappatura. Questo valore predefinito è 0 . |
scheduleParams.startTime |
Ora di inizio designata per l’inizio della prima acquisizione di dati. |
scheduleParams.frequency |
Frequenza con cui il flusso di dati raccoglie i dati. I valori accettabili includono: once , minute , hour , day oppure week . |
scheduleParams.interval |
L'intervallo indica il periodo tra due esecuzioni di flusso consecutive. Il valore dell'intervallo deve essere un numero intero diverso da zero. L'intervallo non è necessario quando la frequenza è impostata come once e deve essere maggiore o uguale a 15 per altri valori di frequenza. |
Risposta
Una risposta corretta restituisce l'ID (id
) del flusso di dati appena creato. Puoi utilizzare questo ID per monitorare, aggiornare o eliminare il flusso di dati.
{
"id": "209812ad-7bef-430c-b5b2-a648aae72094",
"etag": "\"2e01f11d-0000-0200-0000-615649660000\""
}
Una volta creato il flusso di dati, puoi monitorare i dati che vengono acquisiti tramite di esso per visualizzare informazioni sulle esecuzioni del flusso, lo stato di completamento e gli errori.
Formato API
GET /runs?property=flowId=={FLOW_ID}
Richiesta
La richiesta seguente recupera le specifiche per un flusso di dati esistente.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/runs?property=flowId==993f908f-3342-4d9c-9f3c-5aa9a189ca1a' \
-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}'
Risposta
Una risposta corretta restituisce i dettagli relativi all’esecuzione del flusso, incluse informazioni sulla data di creazione, sulle connessioni di origine e di destinazione, nonché l’identificatore univoco dell’esecuzione del flusso (id
).
{
"items": [
{
"id": "209812ad-7bef-430c-b5b2-a648aae72094",
"createdAt": 1633044829955,
"updatedAt": 1633044838006,
"createdBy": "{CREATED_BY}",
"updatedBy": "{UPDATED_BY}",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "MailChimp Members dataflow",
"description": "MailChimp Members dataflow",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"state": "enabled",
"version": "\"2e01f11d-0000-0200-0000-615649660000\"",
"etag": "\"2e01f11d-0000-0200-0000-615649660000\"",
"sourceConnectionIds": [
"e70d2773-711f-43ee-b956-9a1a5da03dd8"
],
"targetConnectionIds": [
"43e141f6-6385-4d80-a4e4-c0fb59abbd43"
],
"inheritedAttributes": {
"sourceConnections": [
{
"id": "e70d2773-711f-43ee-b956-9a1a5da03dd8",
"connectionSpec": {
"id": "2e8580db-6489-4726-96de-e33f5f60295f",
"version": "1.0"
},
"baseConnection": {
"id": "05c595e5-edc3-45c8-90bb-fcf556b57c4b",
"connectionSpec": {
"id": "2e8580db-6489-4726-96de-e33f5f60295f",
"version": "1.0"
}
}
}
],
"targetConnections": [
{
"id": "43e141f6-6385-4d80-a4e4-c0fb59abbd43",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"scheduleParams": {
"startTime": "1633044818",
"frequency": "minute",
"interval": 15
},
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "5a365b23962d4653b9d9be25832ee5b4",
"mappingVersion": 0
}
}
],
"runs": "/flows/209812ad-7bef-430c-b5b2-a648aae72094/runs",
"lastOperation": {
"started": 1633044829988,
"updated": 0,
"operation": "create"
}
}
]
}
Proprietà | Descrizione |
---|---|
items |
Contiene un singolo payload di metadati associati all’esecuzione di flusso specifica. |
id |
Visualizza l'ID corrispondente al flusso di dati. |
state |
Visualizza lo stato corrente del flusso di dati. |
inheritedAttributes |
Contiene gli attributi che definiscono il flusso, ad esempio gli ID per la connessione di base, sorgente e destinazione corrispondente. |
scheduleParams |
Contiene informazioni sulla pianificazione dell’acquisizione del flusso di dati, ad esempio l’ora di inizio (in epoch time), la frequenza e l’intervallo. |
transformations |
Contiene informazioni sulle proprietà di trasformazione applicate al flusso di dati. |
runs |
Visualizza l'ID di esecuzione corrispondente del flusso. Puoi usare questo ID per monitorare esecuzioni di flussi specifiche. |
Per aggiornare la pianificazione, il nome e la descrizione dell’esecuzione del flusso di dati, esegui una richiesta PATCH al Flow Service API fornendo al tempo stesso il tuo ID flusso, la versione e la nuova pianificazione che desideri utilizzare.
La If-Match
l’intestazione è necessaria quando si effettua una richiesta PATCH. Il valore di questa intestazione è la versione univoca della connessione che si desidera aggiornare.
Formato API
PATCH /flows/{FLOW_ID}
Richiesta
La richiesta seguente aggiorna la pianificazione di esecuzione del flusso, nonché il nome e la descrizione del flusso di dati.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/flows/209812ad-7bef-430c-b5b2-a648aae72094' \
-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 'If-Match: "2e01f11d-0000-0200-0000-615649660000"' \
-d '[
{
"op": "replace",
"path": "/scheduleParams/frequency",
"value": "day"
},
{
"op": "replace",
"path": "/name",
"value": "MailChimp Members Dataflow 2.0"
},
{
"op": "replace",
"path": "/description",
"value": "MailChimp Members Dataflow Updated"
}
]'
Parametro | Descrizione |
---|---|
op |
La chiamata dell’operazione utilizzata per definire l’azione necessaria per aggiornare il flusso di dati. Le operazioni includono: add , replace e remove . |
path |
Percorso del parametro da aggiornare. |
value |
Il nuovo valore con cui si desidera aggiornare il parametro. |
Risposta
Una risposta corretta restituisce il tuo ID flusso e un tag aggiornato. Puoi verificare l’aggiornamento effettuando una richiesta GET al Flow Service , fornendo al tempo stesso il tuo ID flusso.
{
"id": "209812ad-7bef-430c-b5b2-a648aae72094",
"etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}
Con un ID flusso esistente, puoi eliminare un flusso di dati eseguendo una richiesta DELETE al Flow Service API.
Formato API
DELETE /flows/{FLOW_ID}
Parametro | Descrizione |
---|---|
{FLOW_ID} |
L'unico id del flusso di dati da eliminare. |
Richiesta
curl -X DELETE \
'https://platform.adobe.io/data/foundation/flowservice/flows/209812ad-7bef-430c-b5b2-a648aae72094' \
-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}'
Risposta
Una risposta corretta restituisce lo stato HTTP 204 (Nessun contenuto) e un corpo vuoto. Puoi confermare l’eliminazione tentando una richiesta di ricerca (GET) al flusso di dati. L’API restituirà un errore HTTP 404 (Non trovato) che indica che il flusso di dati è stato eliminato.
Per aggiornare il nome, la descrizione e le credenziali della tua connessione, esegui una richiesta PATCH al Flow Service API fornendo l'ID di connessione di base, la versione e le nuove informazioni che si desidera utilizzare.
La If-Match
l’intestazione è necessaria quando si effettua una richiesta PATCH. Il valore di questa intestazione è la versione univoca della connessione che si desidera aggiornare.
Formato API
PATCH /connections/{BASE_CONNECTION_ID}
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} |
L'unico id valore della connessione che si desidera aggiornare. |
Richiesta
La richiesta seguente fornisce un nuovo nome e una nuova descrizione, nonché un nuovo set di credenziali, con cui aggiornare la connessione.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa' \
-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 'If-Match: 4000cff7-0000-0200-0000-6154bad60000' \
-d '[
{
"op": "replace",
"path": "/auth/params",
"value": {
"username": "mailchimp-member-activity-user",
"password": "{NEW_PASSWORD}"
}
},
{
"op": "replace",
"path": "/name",
"value": "MailChimp Members Connection 2.0"
},
{
"op": "add",
"path": "/description",
"value": "Updated MailChimp Members Connection"
}
]'
Parametro | Descrizione |
---|---|
op |
Chiamata dell’operazione utilizzata per definire l’azione necessaria per aggiornare la connessione. Le operazioni includono: add , replace e remove . |
path |
Percorso del parametro da aggiornare. |
value |
Il nuovo valore con cui si desidera aggiornare il parametro. |
Risposta
Una risposta corretta restituisce l'ID di connessione di base e un tag aggiornato. Puoi verificare l’aggiornamento effettuando una richiesta GET al Flow Service , fornendo al tempo stesso l'ID di connessione.
{
"id": "4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}
Una volta ottenuto l’ID di connessione di base esistente, esegui una richiesta DELETE al Flow Service API.
Formato API
DELETE /connections/{CONNECTION_ID}
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} |
L'unico id valore della connessione di base che si desidera eliminare. |
Richiesta
curl -X DELETE \
'https://platform.adobe.io/data/foundation/flowservice/connections/4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa' \
-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}'
Risposta
Una risposta corretta restituisce lo stato HTTP 204 (Nessun contenuto) e un corpo vuoto.
Puoi confermare l’eliminazione tentando una richiesta di ricerca (GET) alla connessione.