Gränssnittsattribut

Gränssnittsattribut definierar de visuella element som Adobe ska visa för ditt målkort i Adobe Experience Platform användargränssnitt, till exempel en logotyp, en länk till dokumentationssidan, en målbeskrivning samt dess kategori och typ.

Mer information om var den här komponenten passar in i en integrering som skapas med Destination SDK finns i diagrammet i konfigurationsalternativ eller se följande sidor med översikt över målkonfigurationen:

När skapa ett mål via Destination SDK, uiAttributes -avsnittet definierar följande visuella egenskaper för målkortet:

  • URL:en till måldokumentationssidan i målkatalog.
  • Den kategori som ditt mål ska visas under i plattformsgränssnittet.
  • Dataexportfrekvensen för destinationen.
  • Målanslutningstypen, t.ex. Amazon S3, Azure Blob.
  • Den URL där du var värd för ikonen som ska visas på målkatalogkortet.

Du kan konfigurera gränssnittsattribut via /authoring/destinations slutpunkt. På följande API-referenssidor finns detaljerade API-anropsexempel där du kan konfigurera komponenterna som visas på den här sidan.

I den här artikeln beskrivs alla gränssnittsattribut som stöds och som du kan använda för ditt mål. Här visas vad kunderna kommer att se i användargränssnittet för Experience Platform.

Skärmbild som visar gränssnittsattributen i Experience Platform-gränssnittet

IMPORTANT
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänslig. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Integrationstyper som stöds supported-integration-types

Se tabellen nedan för mer ingående information om vilka typer av integreringar som stöder de funktioner som beskrivs på den här sidan.

Integrationstyp
Stöder funktioner
Integrering i realtid (direktuppspelning)
Ja
Filbaserade (batch) integreringar
Ja

parametrar som stöds supported-parameters

"uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/YOURDESTINATION-en",
      "category":"cloudStorage",
      "connectionType":"S3",
      "frequency":"batch",
      "isBeta":"true"
   }

documentationLink är en strängparameter som refererar till dokumentationssidan i Målkatalog till destinationen. Alla produktioner i Adobe Experience Platform måste ha en motsvarande dokumentationssida. Lär dig hur du skapar en dokumentationssida för målet till destinationen. Observera att detta inte krävs för privata/anpassade destinationer.

Använd följande format: http://www.adobe.com/go/destinations-YOURDESTINATION-en, där YOURDESTINATION är namnet på destinationen. För ett mål som heter Moviestar använder du http://www.adobe.com/go/destinations-moviestar-en.

Användarna kan se och besöka din dokumentationslänk från målkatalogsidan i användargränssnittet. De behöver bläddra till ditt målkort och sedan välja More actions och sedan View documentation, vilket visas i bilden nedan.

Användargränssnittsbild som visar dokumentationslänkens plats.

NOTE
Länken fungerar bara när Adobe har aktiverat destinationen och dokumentationen har publicerats.

category category

category är en strängparameter som refererar till den kategori som tilldelats ditt mål i Adobe Experience Platform. Mer information finns i Målkategorier. Använd något av följande värden: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.

Användarna kan se listan över målkategorier till vänster på skärmen i målkatalogen, som visas i bilden nedan.

Användargränssnittsbild som visar destinationskategorins plats.

connectionType connection-type

connectionType är en strängparameter som refererar till anslutningstypen, beroende på målet. Värden som stöds:

  • Server-to-server
  • Cloud storage
  • Azure Blob
  • Azure Data Lake Storage
  • S3
  • SFTP
  • DLZ

Användarna kan se målanslutningstypen i Bläddra -fliken i målarbetsytan.

Användargränssnittsbild som visar platsen för anslutningstypen i användargränssnittet.

frequency frequency

frequency är en strängparameter som refererar till den typ av dataexport som stöds av ditt mål. Ange till Streaming för API-baserade integreringar, eller Batch när du exporterar filer till dina mål.

Användare kan se frekvenstypen i Dataflow runs sida för varje målanslutning.

Användargränssnittsbild som visar frekvenstypen i användargränssnittet.

isBeta isbeta

Om det mål som du skapar med Destination SDK är tillgängligt för ett begränsat antal kunder kan du markera målkortet från målkatalogen som beta.

Om du vill göra det kan du använda isBeta: "true" i delen UI-attribut i målkonfigurationen för att markera målkortet på rätt sätt.

Användargränssnittsbild som visar ett målkort markerat som beta.

icon icon

Du kan lägga till en logotypikon till målet, vilket visas i bilden nedan.

Användargränssnittsbild som visar ikonens plats.

Om du vill lägga till en logotyp på målkortet måste du dela den önskade bilden med Adobe-teamet när du skicka målet för granskning.

Nästa steg next-steps

När du har läst den här artikeln bör du få en bättre förståelse för vilka gränssnittsattribut du kan konfigurera för ditt mål och var användarna ser dem i plattformsgränssnittet.

Mer information om de andra målkomponenterna finns i följande artiklar:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6