Editar conexiones de destino mediante la API de Flow Service

Este tutorial trata los pasos para editar varios componentes de una conexión de destino. Obtenga información sobre cómo actualizar las credenciales de autenticación, la ubicación de exportación y mucho más utilizando Flow Service API.

NOTE
Actualmente, las operaciones de edición descritas en este tutorial solo se admiten a través de la API de Flow Service.

Introducción get-started

Este tutorial requiere que tenga un ID de flujo de datos válido. Si no tiene un ID de flujo de datos válido, seleccione el destino que desee en la catálogo de destinos y siga los pasos descritos para conectar con el destino y activar datos antes de intentar realizar este tutorial.

NOTE
Los términos fluir y flujo de datos se utilizan indistintamente en este tutorial. En el contexto de este tutorial, tienen el mismo significado.

Este tutorial también requiere tener una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

  • Destinos: Destinations son integraciones prediseñadas con plataformas de destino que permiten la activación perfecta de datos de Adobe Experience Platform. Puede utilizar los destinos para activar los datos conocidos y desconocidos para campañas de marketing entre canales, campañas por correo electrónico, publicidad segmentada y muchos otros casos de uso.
  • Zonas protegidas: El Experience Platform proporciona entornos limitados virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para actualizar correctamente el flujo de datos mediante Flow Service API.

Lectura de llamadas de API de muestra reading-sample-api-calls

Este tutorial proporciona llamadas de API de ejemplo para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados obligatorios y cargas de solicitud con el formato correcto. También se proporciona el JSON de muestra devuelto en las respuestas de la API. Para obtener información sobre las convenciones utilizadas en la documentación de las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas del Experience Platform.

Recopilación de valores para los encabezados obligatorios gather-values-for-required-headers

Para realizar llamadas a las API de Platform, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores de cada uno de los encabezados necesarios en todas las llamadas a la API de Experience Platform, como se muestra a continuación:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Todos los recursos de Experience Platform, incluidos los que pertenecen a Flow Service, están aisladas para zonas protegidas virtuales específicas. Todas las solicitudes a las API de Platform requieren un encabezado que especifique el nombre de la zona protegida en la que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Si la variable x-sandbox-name encabezado no especificado, las solicitudes se resuelven en el prod zona protegida.

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requiere un encabezado de tipo de medios adicional:

  • Content-Type: application/json

Búsqueda de detalles de flujo de datos look-up-dataflow-details

El primer paso para editar la conexión de destino es recuperar los detalles del flujo de datos con el ID de flujo. Puede ver los detalles actuales de un flujo de datos existente realizando una solicitud de GET a /flows punto final.

TIP
Puede utilizar la interfaz de usuario del Experience Platform para obtener el ID de flujo de datos deseado de un destino. Ir a Destinos > Examinar, seleccione el flujo de datos de destino deseado y busque el ID de destino en el carril derecho. El ID de destino es el valor que utilizará como ID de flujo en el siguiente paso.
Obtención del ID de destino mediante la IU de Experience Platform
recommendation-more-help

Formato de API

GET /flows/{FLOW_ID}
Parámetro
Descripción
{FLOW_ID}
La exclusiva id para el flujo de datos de destino que desea recuperar.

Solicitud

La siguiente solicitud recupera información sobre el ID de flujo.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'

Respuesta

Una respuesta correcta devuelve los detalles actuales del flujo de datos, incluida su versión, identificador único (id) y otra información relevante. Los más relevantes para este tutorial son la conexión de destino y los ID de conexión base resaltados en la respuesta que aparece a continuación. Utilizará estos ID en las secciones siguientes para actualizar varios componentes de la conexión de destino.

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            "shortened for brevity"
         ]
      }
   ]

Editar componentes de conexión de destino (ubicación de almacenamiento y otros componentes) patch-target-connection

Los componentes de una conexión de destino difieren según el destino. Por ejemplo, para Amazon S3 destinos, puede actualizar el bloque y la ruta donde se exportan los archivos. Para Pinterest destinos, puede actualizar su Pinterest Advertiser ID y para Google Customer Match puede actualizar su Pinterest Account ID.

Para actualizar los componentes de una conexión de destino, realice una PATCH solicitud a la /targetConnections/{TARGET_CONNECTION_ID} al proporcionar el ID de conexión de destino, la versión y los nuevos valores que desee utilizar. Recuerde que obtuvo el ID de conexión de Target en el paso anterior, cuando inspeccionó un flujo de datos existente en el destino deseado.

IMPORTANT
El If-Match se requiere al realizar una PATCH solicitud. El valor de este encabezado es la versión única de la conexión de destino que desea actualizar. El valor de la etiqueta se actualiza con cada actualización correcta de una entidad de flujo, como flujo de datos, conexión de destino y otras.
Para obtener la última versión del valor de etiqueta, realice una solicitud de GET a /targetConnections/{TARGET_CONNECTION_ID} extremo, donde {TARGET_CONNECTION_ID} es el ID de conexión de destino que desea actualizar.
Asegúrese de ajustar el valor del If-Match encabezado entre comillas dobles, como en los ejemplos siguientes, al realizar PATCH solicitudes.

A continuación se muestran algunos ejemplos de actualización de parámetros en la especificación de conexión de destino para diferentes tipos de destinos. Sin embargo, la regla general para actualizar los parámetros de cualquier destino es la siguiente:

Obtenga el ID de flujo de datos de la conexión > obtenga el ID de conexión de destino > PATCH la conexión de destino con valores actualizados para los parámetros deseados.

Formato de API

PATCH /targetConnections/{TARGET_CONNECTION_ID}
Amazon S3

Solicitud

La siguiente solicitud actualiza el bucketName y path parámetros de un Amazon S3 conexión de destino.

code language-shell
curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "replace",
    "path": "/params",
    "value": {
      "bucketName": "newBucketName",
      "path": "updatedPath"
    }
  }
]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
op La llamada de operación utilizada para definir la acción necesaria para actualizar el flujo de datos. Las operaciones incluyen: add, replace, y remove.
path Define la parte del flujo que se va a actualizar.
value El nuevo valor con el que desea actualizar el parámetro.

Respuesta

Una respuesta correcta devuelve el ID de conexión de destino y una etiqueta electrónica actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión de destino.

code language-json
{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}
Google Ad Manager y Google Ad Manager 360

Solicitud

La siguiente solicitud actualiza los parámetros de un Google Ad Manager o Google Ad Manager 360 destino conexión para agregar el nuevo Anexar ID de audiencia al nombre de audiencia field.

code language-shell
curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/params/appendSegmentId",
    "value": true
  }
]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
op La llamada de operación utilizada para definir la acción necesaria para actualizar el flujo de datos. Las operaciones incluyen: add, replace, y remove.
path Define la parte del flujo que se va a actualizar.
value El nuevo valor con el que desea actualizar el parámetro.

Respuesta

Una respuesta correcta devuelve el ID de conexión de destino y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión de destino.

code language-json
{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}
Pinterest

Solicitud

La siguiente solicitud actualiza el advertiserId parámetro de a Pinterest conexión de destino.

code language-shell
curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "replace",
    "path": "/params",
    "value": {
      "advertiser_id": "1234567890"
    }
  }
]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
op La llamada de operación utilizada para definir la acción necesaria para actualizar el flujo de datos. Las operaciones incluyen: add, replace, y remove.
path Define la parte del flujo que se va a actualizar.
value El nuevo valor con el que desea actualizar el parámetro.

Respuesta

Una respuesta correcta devuelve el ID de conexión de destino y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión de destino.

code language-json
{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Editar componentes de conexión base (parámetros de autenticación y otros componentes) patch-base-connection

Edite la conexión base cuando desee actualizar las credenciales de un destino. Los componentes de una conexión base difieren según el destino. Por ejemplo, para Amazon S3 destinos, puede actualizar la clave de acceso y la clave secreta a su Amazon S3 ubicación.

Para actualizar los componentes de una conexión base, realice una PATCH solicitud a la /connections al mismo tiempo que proporciona su ID de conexión base, versión y los nuevos valores que desea utilizar.

Recuerde, tiene su ID de conexión base en un paso anterior, cuando inspeccionó un flujo de datos existente en el destino deseado para el parámetro baseConnection.

IMPORTANT
El If-Match se requiere al realizar una PATCH solicitud. El valor de este encabezado es la versión única de la conexión base que desea actualizar. El valor de la etiqueta se actualiza con cada actualización correcta de una entidad de flujo, como flujo de datos, conexión base y otras.
Para obtener la última versión del valor Etag, realice una solicitud de GET a /connections/{BASE_CONNECTION_ID} extremo, donde {BASE_CONNECTION_ID} es el ID de conexión base que desea actualizar.
Asegúrese de ajustar el valor del If-Match encabezado entre comillas dobles, como en los ejemplos siguientes, al realizar PATCH solicitudes.

A continuación se muestran algunos ejemplos de actualización de parámetros en la especificación de conexión base para diferentes tipos de destinos. Sin embargo, la regla general para actualizar los parámetros de cualquier destino es la siguiente:

Obtenga el ID de flujo de datos de la conexión > obtenga el ID de conexión base > PATCH la conexión base con valores actualizados para los parámetros deseados.

Formato de API

PATCH /connections/{BASE_CONNECTION_ID}
Amazon S3

Solicitud

La siguiente solicitud actualiza el accessId y secretKey parámetros de un Amazon S3 conexión de destino.

code language-shell
curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/auth/params",
    "value": {
      "accessId": "exampleAccessId",
      "secretKey": "exampleSecretKey"
    }
  }
]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
op La llamada de operación utilizada para definir la acción necesaria para actualizar el flujo de datos. Las operaciones incluyen: add, replace, y remove.
path Define la parte del flujo que se va a actualizar.
value El nuevo valor con el que desea actualizar el parámetro.

Respuesta

Una respuesta correcta devuelve el ID de conexión base y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión base.

code language-json
{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}
Azure Blob

Solicitud

La siguiente solicitud actualiza los parámetros de un Azure Blob destino para actualizar la cadena de conexión necesaria para conectarse a una instancia de Azure Blob.

code language-shell
curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/auth/params",
    "value": {
      "connectionString": "updatedString"
    }
  }
]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propiedad Descripción
op La llamada de operación utilizada para definir la acción necesaria para actualizar el flujo de datos. Las operaciones incluyen: add, replace, y remove.
path Define la parte del flujo que se va a actualizar.
value El nuevo valor con el que desea actualizar el parámetro.

Respuesta

Una respuesta correcta devuelve el ID de conexión base y una etiqueta actualizada. Puede comprobar la actualización realizando una solicitud de GET a Flow Service API, mientras proporciona su ID de conexión base.

code language-json
{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Administración de errores de API api-error-handling

Los extremos de la API en este tutorial siguen los principios generales del mensaje de error de la API del Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la Guía de solución de problemas de Platform para obtener más información sobre cómo interpretar las respuestas de error.

Pasos siguientes next-steps

Al seguir este tutorial, ha aprendido a actualizar varios componentes de una conexión de destino con la variable Flow Service API. Para obtener más información sobre los destinos, consulte la información general sobre destinos.

7f4d1967-bf93-4dba-9789-bb6b505339d6