Catalog Service guia do desenvolvedor

Catalog Service é o sistema de registro para localização e linhagem de dados no Adobe Experience Platform. Catalog atua como um armazenamento de metadados ou "catálogo" no qual você pode encontrar informações sobre seus dados Experience Platform, sem precisar acessar os próprios dados. Consulte a Catalog visão geral para obter mais informações.

Este guia do desenvolvedor fornece etapas para ajudá-lo a start usando a Catalog API. O guia então fornece exemplos de chamadas de API para executar operações principais usando Catalog.

Pré-requisitos

Catalog rastreia metadados para vários tipos de recursos e operações dentro Experience Platform. Este guia do desenvolvedor requer um entendimento prático dos vários Experience Platform serviços envolvidos na criação e gerenciamento desses recursos:

  • Experience Data Model (XDM): A estrutura padronizada pela qual Platform organiza os dados de experiência do cliente.
  • Ingestãoem lote: Como Experience Platform ingere e armazena dados de arquivos de dados, como CSV e Parquet.
  • Inclusãode transmissão: Como Experience Platform ingere e armazena dados de dispositivos do cliente e do servidor em tempo real.

As seções a seguir fornecem informações adicionais que você precisará conhecer ou ter em mãos para fazer chamadas à Catalog Service API com êxito.

Lendo chamadas de exemplo da API

Este guia fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de amostra, consulte a seção sobre como ler chamadas de API de exemplo no guia de Experience Platform solução de problemas.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para Platform APIs, você deve primeiro concluir o tutorial deautenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de Experience Platform API, como mostrado abaixo:

  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos os recursos em Experience Platform são isolados para caixas de proteção virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
Observação

Para obter mais informações sobre caixas de proteção em Platform, consulte a documentação de visão geral dacaixa de proteção.

Todas as solicitações que contêm uma carga (POST, PUT, PATCH) exigem um cabeçalho adicional:

  • Tipo de conteúdo: application/json

Práticas recomendadas para chamadas de Catalog API

Ao executar solicitações de GET para a Catalog API, a prática recomendada é incluir parâmetros de query em suas solicitações para retornar somente os objetos e propriedades de que você precisa. As solicitações não filtradas podem fazer com que as cargas de resposta atinjam mais de 3 GB, o que pode retardar o desempenho geral.

Você pode visualização objetos específicos incluindo sua ID no caminho da solicitação ou usar parâmetros de query, como properties e limit para filtrar respostas. Os filtros podem ser passados como cabeçalhos e como parâmetros de query, com aqueles passados como parâmetros de query tendo prioridade. Consulte o documento sobre como filtrar dados do catálogo para obter mais informações.

Como alguns query podem sobrecarregar a API, limites globais foram implementados em Catalog query para oferecer suporte adicional às práticas recomendadas.

Próximas etapas

Esse documento cobria os conhecimentos pré-requisitos necessários para fazer chamadas para a Catalog API. Agora você pode continuar com as chamadas de amostra fornecidas neste guia do desenvolvedor e seguir com suas instruções.

A maioria dos exemplos neste guia usam o /dataSets endpoint, mas os princípios podem ser aplicados a outros endpoints dentro Catalog (como /batches e /accounts). Consulte a referência API do serviço de catálogo para obter uma lista completa de todas as chamadas e operações disponíveis para cada terminal.

Para obter um fluxo de trabalho passo a passo que demonstra como a Catalog API está envolvida com a ingestão de dados, consulte o tutorial sobre como criar um conjunto de dados.

Nesta página