Show Menu
ARGOMENTI×

Catalog Service guida per sviluppatori

Catalog Service è il sistema di record per la posizione dei dati e la linea all'interno Adobe Experience Platform. Catalog funge da archivio di metadati o "catalogo" in cui è possibile trovare informazioni sui dati al loro interno Experience Platform, senza necessità di accedere ai dati stessi. Per ulteriori informazioni, consultate la panoramica del catalogo.
Questa guida per gli sviluppatori fornisce i passaggi necessari per iniziare a utilizzare l' Catalog API. La guida fornisce quindi chiamate API di esempio per eseguire operazioni chiave utilizzando Catalog.

Prerequisiti

Catalog tiene traccia dei metadati per diversi tipi di risorse e operazioni all’interno Experience Platform. Questa guida per gli sviluppatori richiede una buona conoscenza dei vari Experience Platform servizi coinvolti nella creazione e gestione di tali risorse:
  • Experience Data Model (XDM) : Il framework standard con cui Platform organizzare i dati relativi all'esperienza del cliente.
  • Caricamento batch: Modalità di Experience Platform acquisizione e memorizzazione dei dati dai file di dati, come CSV e Parquet.
  • Caricamento streaming: Modalità di Experience Platform acquisizione e memorizzazione in tempo reale dei dati da dispositivi lato client e lato server.
Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere o avere a disposizione per eseguire correttamente le chiamate all' Catalog Service API.

Lettura di chiamate API di esempio

Questa guida fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, vedete la sezione come leggere chiamate API di esempio nella guida alla Experience Platform risoluzione dei problemi.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle Platform API, è prima necessario completare l'esercitazione sull' autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate Experience Platform API, come illustrato di seguito:
  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform sono isolate in sandbox virtuali specifiche. Tutte le richieste alle Platform API richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione:
  • x-sandbox-name: {SANDBOX_NAME}
Per ulteriori informazioni sulle sandbox in Platform, consultate la documentazione sulla panoramica della sandbox.
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva:
  • Content-Type: application/json

Procedure ottimali per le chiamate Catalog API

Quando si eseguono richieste di GET all' Catalog API, è consigliabile includere nelle richieste i parametri di query per restituire solo gli oggetti e le proprietà necessari. Le richieste non filtrate possono portare i payload di risposta a oltre 3 GB di dimensione, il che può rallentare le prestazioni complessive.
È possibile visualizzare oggetti specifici includendo il relativo ID nel percorso della richiesta o utilizzare parametri di query quali properties e limit per filtrare le risposte. I filtri possono essere passati come intestazioni e come parametri di query, con quelli passati come parametri di query che hanno la precedenza. Per ulteriori informazioni, consulta il documento sul filtro dei dati del catalogo.
Poiché alcune query possono causare un notevole carico sulle API, sono stati implementati limiti globali sulle Catalog query per supportare ulteriormente le procedure ottimali.

Passaggi successivi

Questo documento ha trattato le conoscenze preliminari necessarie per effettuare chiamate all' Catalog API. Potete ora procedere alle chiamate di esempio fornite in questa guida per gli sviluppatori e seguire le relative istruzioni.
La maggior parte degli esempi in questa guida utilizza l' /dataSets endpoint, ma i principi possono essere applicati ad altri endpoint all'interno di Catalog (come /batches e /accounts ). Consultate il riferimento API Catalog Service per un elenco completo di tutte le chiamate e le operazioni disponibili per ciascun endpoint.
Per un flusso di lavoro dettagliato che illustra come l' Catalog API è coinvolta nell'assimilazione dei dati, vedete l'esercitazione sulla creazione di un dataset .