Documentação Experience Platform Guia de sandoxes

Endpoint de pacotes

Last update: Thu Jul 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Desenvolvedor
Usuário
Administrador
Líder

As ferramentas de sandbox permitem selecionar diferentes artefatos (também conhecidos como objetos) e exportá-los em um pacote. Um pacote pode consistir em um único artefato ou em vários artefatos (como conjuntos de dados ou esquemas). Todos os artefatos incluídos em um pacote devem ser da mesma sandbox.

O ponto de extremidade /packages na API de ferramentas da sandbox permite gerenciar de forma programática os pacotes em sua organização, incluindo a publicação de um pacote e a importação de um pacote para uma sandbox.

Criar um pacote create

Você pode criar um pacote de vários artefatos fazendo uma solicitação POST para o ponto de extremidade /packages enquanto fornece valores para o nome e o tipo do pacote.

Formato da API

POST /packages/

Solicitação

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/packages \
  -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}' \
  -d'{
      "name": "acme",
      "description": "Acme Business Group",
      "packageType": "PARTIAL",
      "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
      },
      "expiry": "2023-05-20T20:05:10Z",
      "artifacts": [
        {
          "id": "27115daa-c92b-4f17-a077-d65ffeb0c525",
          "type": "PROFILE_SEGMENT",
          "title": "Acme Profile Segment"
        }
      ]
  }'

Propriedade

Descrição

Tipo

Obrigatório

name

O nome do seu pacote.

String

Sim

description

Uma descrição para fornecer mais informações sobre o pacote.

String

Não

packageType

O tipo de pacote é PARCIAL para indicar que você está incluindo artefatos específicos em um pacote.

String

SIM

sourceSandbox

A sandbox de origem do pacote.

Objeto

Não

expiry

O carimbo de data e hora que define a data de expiração do pacote. O valor padrão é 90 dias a partir da data de criação. O campo de expiração da resposta será a hora UTC da época.

String (formato de carimbo de data e hora UTC)

Não

artifacts

Uma lista de artefatos a serem exportados para o pacote. O valor artifacts deve ser nulo ou vazio, quando packageType for FULL.

Matriz

Não

Resposta

Uma resposta bem-sucedida retorna o pacote recém-criado. A resposta inclui a ID do pacote correspondente, bem como informações sobre status, expiração e lista de artefatos.

{
    "id": "209f886b00444eac9bb5836fe32e7681",
    "version": 0,
    "createdDate": 1684475012105,
    "modifiedDate": 1684475012105,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "requestId": "devxa54a6b56d04f46119d9e3cc006fcc1cb",
    "userId": "platform_exim",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "sourceSandbox": {
        "name": "cjm-mr",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "packageType": "PARTIAL",
    "expiry": 1684613110000,
    "status": "DRAFT",
    "artifactsList": [
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ]
}

Atualizar um pacote update

Use o ponto de extremidade /packages na API de ferramentas da sandbox para atualizar um pacote.

Adicionar artefatos a um pacote add-artifacts

Para adicionar artefatos a um pacote, você deve fornecer um id e incluir ADD para o action.

Formato da API

PUT /packages/

Solicitação

curl -X PUT \
  https://platform.adobe.io/data/foundation/exim/packages \
  -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}' \
  -d'{
      "id": "6fa50baedd344a278129a87e68cc9dc7",
      "action": "ADD",
      "expiry": "2023-05-20T20:05:10Z",
      "artifacts": [
        {
         "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29@1647559351683",
         "type": "JOURNEY"
        }
      ]
  }'

Propriedade

Descrição

Tipo

Obrigatório

id

A ID do pacote a ser atualizado.

String

Sim

action

Para adicionar artefatos ao pacote, o valor da ação deve ser ADICIONAR. Esta ação só tem suporte para tipos de pacote PARTIAL.

String

Sim

artifacts

Uma lista de artefatos a serem adicionados ao pacote. Não haveria alteração no pacote se a lista fosse nula ou vazia. Os artefatos são deduplicados antes de serem adicionados ao pacote. Consulte a tabela abaixo para obter uma lista completa de artefatos compatíveis.

Matriz

Não

expiry

O carimbo de data e hora que define a data de expiração do pacote. O valor padrão é 90 dias a partir do momento em que a API do PUT é chamada, se a expiração não for especificada na carga. O campo de expiração da resposta será a hora UTC da época.

String (formato de carimbo de data e hora UTC)

Não

Os seguintes tipos de artefatos são suportados no momento.

Artefato

Plataforma

Objeto

Fluxo parcial

Sandbox completa

JOURNEY

Adobe Journey Optimizer

Jornadas

Sim

Não

ID_NAMESPACE