Catalog Service Manual da API

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

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

Este manual do desenvolvedor fornece etapas para ajudar a começar a usar a API Catalog. O guia fornece chamadas de API de exemplo para executar operações importantes 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 dos vários Experience Platform serviços envolvidos na criação e no gerenciamento desses recursos:

  • Experience Data Model (XDM): a estrutura padronizada pela qual a Platform organiza os dados de experiência do cliente.
  • Assimilação em lote: Como Experience Platform A assimila e armazena dados de arquivos de dados, como CSV e Parquet.
  • Assimilação por transmissão: Como Experience Platform A assimila e armazena dados de dispositivos do lado do cliente e do lado do 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 com êxito para o Catalog Service API.

Leitura de chamadas de API de amostra

Este manual fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. 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 chamadas de API de exemplo no manual de solução de problemas da Experience Platform.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para APIs da Platform, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API da Experience Platform, 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 isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

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

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

Todas as solicitações que contêm um conteúdo (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 o Catalog API, a prática recomendada é incluir parâmetros de consulta em suas solicitações para retornar somente os objetos e as propriedades necessárias. Solicitações não filtradas podem fazer com que as cargas de resposta atinjam tamanhos acima de 3 GB, o que pode retardar o desempenho geral.

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

Como alguns queries podem colocar uma carga pesada sobre a API, limites globais foram implementados em Catalog consultas para oferecer mais suporte às práticas recomendadas.

Próximas etapas

Este documento cobriu os conhecimento necessários para fazer chamadas para a API da Catalog. Agora você pode prosseguir para as chamadas de amostra fornecidas neste manual do desenvolvedor e seguir suas instruções.

A maioria dos exemplos neste guia usa o /dataSets endpoint, mas os princípios podem ser aplicados a outros endpoints dentro Catalog (como /batches). 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 Catalog A API está envolvida com a assimilação de dados, consulte o tutorial sobre criação de um conjunto de dados.

Nesta página