Exportar esquemas XDM na interface do

Última atualização em 2023-09-29
  • Tópicos
  • Schemas
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

Todos os recursos na Biblioteca de esquemas estão contidos em uma sandbox específica em uma organização. Em alguns casos, é possível compartilhar recursos do Experience Data Model (XDM) entre sandboxes e organizações.

Para atender a essa necessidade, a Esquemas O espaço de trabalho na interface do Adobe Experience Platform permite gerar uma carga de exportação para qualquer esquema na Biblioteca de esquemas. Essa carga pode ser usada em uma chamada à API do Registro de esquema para importar o esquema (e todos os recursos dependentes) para uma sandbox e organização de destino.

OBSERVAÇÃO

Você também pode usar a API do Registro de esquema para exportar outros recursos além de esquemas, incluindo classes, grupos de campos de esquema e tipos de dados. Consulte a exportar guia de endpoint para obter mais informações.

Pré-requisitos

Embora a interface da Platform permita exportar recursos XDM, você deve usar a API do Registro de esquema para importar esses recursos para outras sandboxes ou organizações para concluir o fluxo de trabalho. Consulte o guia sobre introdução à API do Registro de esquema para obter informações importantes sobre os cabeçalhos de autenticação necessários, antes de seguir este guia.

Gerar uma carga de exportação

As cargas úteis de exportação podem ser geradas na interface do usuário da Platform no painel de detalhes na Procurar ou diretamente da tela do schema no Editor de esquemas.

Para gerar uma carga de exportação, selecione Esquemas no painel de navegação esquerdo. No prazo de Esquemas selecione a linha do esquema que deseja exportar para exibir os detalhes do esquema na barra lateral direita.

DICA

Consulte o guia sobre exploração de recursos XDM para obter detalhes sobre como encontrar o recurso XDM que você está procurando.

Em seguida, selecione o Copiar JSON ícone (Ícone Copiar) nas opções disponíveis.

O espaço de trabalho Esquemas com uma linha de esquema e Copiar para JSON destacado.

Isso copia uma carga JSON para a área de transferência, gerada com base na estrutura do esquema. Para o "Loyalty Members" mostrado acima, o seguinte JSON é gerado:

[
  {
    "$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/9ecfd881d0053568d277b792e4d24c6b70ffa7782bd31265",
    "meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.mixins.9ecfd881d0053568d277b792e4d24c6b70ffa7782bd31265",
    "meta:resourceType": "mixins",
    "version": "1.0",
    "title": "Loyalty details",
    "type": "object",
    "description": "",
    "definitions": {
      "customFields": {
        "type": "object",
        "properties": {
          "_<XDM_TENANTID_PLACEHOLDER>": {
            "type": "object",
            "properties": {
              "loyalty": {
                "title": "Loyalty",
                "description": "",
                "type": "object",
                "isRequired": false,
                "required": [

                ],
                "properties": {
                  "loyaltyId": {
                    "title": "Loyalty ID",
                    "description": "",
                    "type": "string",
                    "isRequired": false,
                    "required": [

                    ],
                    "meta:xdmType": "string"
                  },
                  "memberSince": {
                    "title": "Member Since",
                    "description": "",
                    "type": "string",
                    "isRequired": false,
                    "required": [

                    ],
                    "format": "date",
                    "meta:xdmType": "date"
                  },
                  "points": {
                    "title": "Points",
                    "description": "",
                    "type": "integer",
                    "isRequired": false,
                    "required": [

                    ],
                    "meta:xdmType": "int"
                  },
                  "loyaltyLevel": {
                    "title": "Loyalty Level",
                    "description": "",
                    "type": "string",
                    "isRequired": false,
                    "required": [

                    ],
                    "enum": [
                      "platinum",
                      "gold",
                      "silver",
                      "bronze"
                    ],
                    "meta:enum": {
                      "platinum": "Platinum",
                      "gold": "Gold",
                      "silver": "Silver",
                      "bronze": "Bronze"
                    },
                    "meta:xdmType": "string"
                  }
                },
                "meta:xdmType": "object"
              }
            },
            "meta:xdmType": "object"
          }
        },
        "meta:xdmType": "object"
      }
    },
    "allOf": [
      {
        "$ref": "#/definitions/customFields",
        "type": "object",
        "meta:xdmType": "object"
      }
    ],
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:intendedToExtend": [

    ],
    "meta:xdmType": "object",
    "meta:sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
    "meta:sandboxType": "production"
  },
  {
    "$id": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/schemas/1e5a739ded8fd1d766a0e06e881a38031874dddd1c7020ad",
    "meta:altId": "_<XDM_TENANTID_PLACEHOLDER>.schemas.1e5a739ded8fd1d766a0e06e881a38031874dddd1c7020ad",
    "meta:resourceType": "schemas",
    "version": "1.4",
    "title": "Loyalty Members",
    "type": "object",
    "description": "Describes customers who are members of a loyalty program.",
    "allOf": [
      {
        "$ref": "https://ns.adobe.com/xdm/context/profile",
        "type": "object",
        "meta:xdmType": "object"
      },
      {
        "$ref": "https://ns.adobe.com/xdm/context/profile-person-details",
        "type": "object",
        "meta:xdmType": "object"
      },
      {
        "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details",
        "type": "object",
        "meta:xdmType": "object"
      },
      {
        "$ref": "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/9ecfd881d0053568d277b792e4d24c6b70ffa7782bd31265",
        "type": "object",
        "meta:xdmType": "object"
      },
      {
        "$ref": "https://ns.adobe.com/xdm/mixins/profile-consents",
        "type": "object",
        "meta:xdmType": "object"
      }
    ],
    "meta:extensible": false,
    "meta:abstract": false,
    "meta:extends": [
      "https://ns.adobe.com/xdm/context/profile-person-details",
      "https://ns.adobe.com/xdm/context/profile-personal-details",
      "https://ns.adobe.com/xdm/common/auditable",
      "https://ns.adobe.com/xdm/data/record",
      "https://ns.adobe.com/xdm/context/profile",
      "https://ns.adobe.com/<XDM_TENANTID_PLACEHOLDER>/mixins/9ecfd881d0053568d277b792e4d24c6b70ffa7782bd31265",
      "https://ns.adobe.com/xdm/mixins/profile-consents"
    ],
    "meta:xdmType": "object",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
    "meta:sandboxType": "production",
    "meta:immutableTags": [

    ]
  }
]

A carga também pode ser copiada selecionando Mais na parte superior direita do Editor de esquemas. Um menu suspenso fornece duas opções, Copiar estrutura JSON e Excluir esquema.

OBSERVAÇÃO

Um esquema não pode ser excluído quando está habilitado para o Perfil ou tem conjuntos de dados associados.

O Editor de esquemas com Mais e Copiar para JSON destacado.

A carga assume a forma de uma matriz, com cada item de matriz sendo um objeto que representa um recurso XDM personalizado a ser exportado. No exemplo acima, o "Loyalty details"grupo de campos personalizados" e a "Loyalty Members" esquema estão incluídos. Quaisquer recursos principais empregados pelo esquema não são incluídos na exportação, pois esses recursos estão disponíveis em todas as sandboxes e organizações.

Observe que cada instância da ID de locatário da organização aparece como <XDM_TENANTID_PLACEHOLDER> na carga útil. Esses espaços reservados serão substituídos automaticamente pelo valor de ID do locatário apropriado, dependendo de onde você importa o esquema na próxima etapa.

Importar o recurso usando a API

Depois de copiar o JSON de exportação para o esquema, você pode usá-lo como carga para uma solicitação POST para o /rpc/import ponto de extremidade na API do Registro de esquema. Consulte a guia de endpoint de importação para obter detalhes sobre como configurar a chamada para enviar o esquema para a organização e a sandbox desejadas.

Próximas etapas

Ao seguir este guia, você exportou com êxito um esquema XDM para uma organização ou sandbox diferente. Para obter mais informações sobre os recursos do Esquemas consulte a Esquemas Visão geral da interface.

Nesta página