Catalog Service Manual da API

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", onde você pode encontrar informações sobre seus dados no Experience Platform, sem precisar acessar os dados propriamente ditos. Consulte a Catalog visão geral para obter mais informações.

Este guia do desenvolvedor fornece etapas para ajudá-lo a começar a usar o Catalog API. O guia 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 no Experience Platform. Este guia do desenvolvedor requer uma compreensão funcional das várias Experience Platform serviços envolvidos na criação e gerenciamento desses recursos:

  • Experience Data Model (XDM): O quadro normalizado pelo qual Platform organiza os dados de experiência do cliente.
  • Ingestão em lote: How Experience Platform O assimila e armazena dados de arquivos de dados, como CSV e Parquet.
  • Assimilação de fluxo: How Experience Platform O assimila e armazena dados de dispositivos cliente e servidor em tempo real.

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

Lendo exemplos de chamadas de API

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

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Platform As APIs devem ser concluídas primeiro tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todos Experience Platform Chamadas de API, conforme mostrado abaixo:

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

Todos os recursos em Experience Platform são isoladas em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
OBSERVAÇÃO

Para obter mais informações sobre sandboxes em Platform, consulte o documentação de visão geral da sandbox.

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

  • Tipo de conteúdo: application/json

Práticas recomendadas para Catalog Chamadas de API

Ao executar solicitações do GET para a Catalog API, a prática recomendada é incluir parâmetros de consulta em suas solicitações para retornar somente os objetos e propriedades necessários. 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.

É possível exibir objetos específicos incluindo a ID no caminho da solicitação ou usar parâmetros de consulta, como properties e limit para filtrar as respostas. Os filtros podem ser passados como cabeçalhos e como parâmetros de consulta, com aqueles passados como parâmetros de consulta tendo prioridade. Consulte o documento em filtrar dados do catálogo para obter mais informações.

Como algumas consultas podem aumentar a carga da API, os limites globais foram implementados em Catalog consultas para oferecer suporte adicional às práticas recomendadas.

Próximas etapas

Este documento cobria os pré-requisitos necessários para fazer chamadas para o Catalog API. Agora você pode prosseguir para as chamadas de exemplo fornecidas neste guia do desenvolvedor e seguir com suas instruções.

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

Para um fluxo de trabalho passo a passo que demonstra como a variável Catalog A API está envolvida com a assimilação de dados, consulte o tutorial em criação de um conjunto de dados.

Nesta página