[AEM Assets]{class="badge positive" title="Gäller AEM Assets)."}

Installation och egenskaper för Content Advisor content-advisor-installation-properties

Content Advisor är också tillgängligt för integrering med andra program än Adobe (tredjepartsprogram), vilket gör att intelligent resursidentifiering kan användas även utanför Adobe-program. Samma omfattande funktionsuppsättning, inklusive AI-baserad sökning, kontextmedvetna rekommendationer, kampanjbaserad identifiering, åtkomst till dynamiska medierenderingar, identifiering av innehållsfragment, filter och metadata för mediefiler, stöds i tredjepartsintegrationer.

Förutsättningar prereqs

Du måste se till att följande kommunikationsmetoder används:

  • Värdprogrammet körs på HTTPS.
  • Du kan inte köra programmet på localhost. Om du vill integrera Content Advisor på din lokala dator måste du skapa en anpassad domän, till exempel [https://<your_campany>.localhost.com:<port_number>], och lägga till den anpassade domänen i redirectUrl list.
  • Du kan konfigurera och lägga till clientID i AEM Cloud-tjänstmiljövariabeln med respektive imsClientId.
  • Listan med IMS-scope måste definieras i miljökonfigurationen.
  • Programmets URL finns i IMS-klientens tillåtelselista i omdirigerings-URL:er.
  • Inloggningsflödet för IMS konfigureras och återges med hjälp av en popup-meny i webbläsaren. Därför bör popup-fönster vara aktiverade eller tillåtna i målwebbläsaren.

Använd ovanstående krav om du behöver arbetsflödet för IMS-autentisering i Content Advisor. Om du redan är autentiserad med IMS-arbetsflödet kan du lägga till IMS-informationen i stället.

IMPORTANT
Den här databasen är avsedd att fungera som kompletterande dokumentation som beskriver tillgängliga API:er och användningsexempel för integrering av Content Advisor. Innan du försöker installera eller använda Content Advisor måste du se till att din organisation har fått åtkomst till Content Advisor som en del av Experience Manager Assets as a Cloud Service-profilen. Om du inte har etablerats kan du inte integrera eller använda dessa komponenter. För att begära etablering bör programadministratören skaffa en supportanmälan som är markerad som P2 från Admin Console och innehålla följande information:
  • Domännamn där det integrerande programmet finns.
  • Efter etableringen kommer din organisation att få imsClientId, imsScope och en redirectUrl som motsvarar de miljöer som efterfrågas och som är nödvändiga för konfigurationen av Content Advisor. Utan dessa giltiga egenskaper kan du inte köra installationsstegen.

Installation content-advisor-installation

Content Advisor är tillgängligt via både ESM CDN (till exempel version esm.sh/skypack) och version UMD.

I webbläsare som använder UMD-version (rekommenderas):

<script src="https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/assets-selectors.js"></script>

<script>
  const { renderAssetSelector } = PureJSSelectors;
</script>

I webbläsare med import maps-stöd och ESM CDN-version:

<script type="module">
  import { AssetSelector } from 'https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/@assets/selectors/index.js'
</script>

I Deno/Webpack Module Federation med ESM CDN version:

import { AssetSelector } from 'https://experience.adobe.com/solutions/CQ-assets-selectors/static-assets/resources/@assets/selectors/index.js'

Egenskaper för Content Advisor content-advisor-propertiess

Du kan använda egenskaperna för Content Advisor för att anpassa hur Content Advisor återges. I följande tabell visas de egenskaper som du kan använda för att anpassa och använda Content Advisor.

Egenskap
Typ
Obligatoriskt
Standard
Beskrivning
järnväg
Boolean
Nej
Falskt
Om true är markerat återges Content Advisor i den vänstra vyn. Om den är markerad som false återges Content Advisor i modal vy.
imsOrg
Sträng
Ja
Adobe Identity Management System (IMS) ID som tilldelas när Adobe Experience Manager etableras som Cloud Service för din organisation. Nyckeln imsOrg krävs för att autentisera om organisationen du försöker få åtkomst till är under Adobe IMS eller inte.
imsToken
Sträng
Nej
IMS-innehavartoken används för autentisering. imsToken krävs om du använder ett Adobe-program för integreringen.
apiKey
Sträng
Nej
API-nyckel som används för åtkomst till AEM Discovery-tjänsten. apiKey krävs om du använder en Adobe-programintegrering.
externalBrief
Sträng
Nej
Gör att du kan överföra ett kampanjdokument för att identifiera relevanta resurser utan att behöva ange söknyckelord manuellt. Content Advisor analyserar informationen i kampanjöversikten för att förstå kampanjens avsikt och rekommenderar relevanta resurser som är tillgängliga i AEM Assets.
filterSchema
Array
Nej
Modell som används för att konfigurera filteregenskaper. Detta är användbart när du vill begränsa vissa filteralternativ i Content Advisor.
filterFormProps
Objekt
Nej
Ange de filteregenskaper som du behöver använda för att förfina sökningen. För! Exempel: MIME-typ JPG, PNG, GIF.
selectedAssets
Matris <Object>
Nej
Ange vald Assets när Content Advisor återges. Det krävs en array med objekt som innehåller en id-egenskap för resurserna. [{id: 'urn:234}, {id: 'urn:555'}] En resurs måste till exempel vara tillgänglig i den aktuella katalogen. Om du behöver använda en annan katalog anger du även ett värde för egenskapen path.
acvConfig
Objekt
Nej
Resurssamlingens visningsegenskap som innehåller objekt med anpassad konfiguration som åsidosätter standardvärden. Den här egenskapen används också med egenskapen rail för att aktivera spårningsvisning av resursvyn.
i18nSymboler
Object<{ id?: string, defaultMessage?: string, description?: string}>
Nej
Om OTB-översättningarna inte är tillräckliga för ditt programs behov kan du visa ett gränssnitt genom vilket du kan skicka dina egna anpassade, lokaliserade värden via i18nSymbols-proppen. Om du skickar ett värde genom det här gränssnittet åsidosätts standardöversättningarna och i stället används dina egna. Om du vill utföra åsidosättningen måste du skicka ett giltigt Message Descriptor-objekt till nyckeln för i18nSymbols som du vill åsidosätta.
intl
Objekt
Nej
Content Advisor tillhandahåller OOTB-standardöversättningar. Du kan välja översättningsspråk genom att ange en giltig språksträng via intl.locale-utkastet. Till exempel: intl={{ locale: "es-es" }}

De språksträngar som stöds följer ISO 639 - Codes för att representera namn på språkstandarder.

Lista över språkområden som stöds: Engelska - en-us (standard) spanska - es-es' German - de-de' French - fr-fr' Italian - it-it-it' Japanese - ja-jp' Korean - ko-kr' Portuguese - pt-br' Chinese (Traditional) - zh-cn' Chinese (Taiwan) - zh-tw
databaseId
Sträng
Nej
''
Databas där Content Advisor läser in innehållet.
additionalAemSolutions
Array<string>
Nej
[ ]
Här kan du lägga till en lista med ytterligare AEM-databaser. Om ingen information anges i den här egenskapen beaktas endast mediebibliotek eller AEM Assets-databaser.
hideTreeNav
Boolean
Nej
Anger om navigeringssidofältet för resursträd ska visas eller döljas. Den används endast i modal vy och därför har den här egenskapen ingen effekt i järnvägsvy.
onDrop
Funktion
Nej
Funktionen för att släppa används för att dra en resurs och släppa den på ett särskilt släppområde. Det möjliggör interaktiva användargränssnitt där resurser kan flyttas och bearbetas sömlöst.
dropOptions
{allowList?: Object}
Nej
Konfigurerar släppningsalternativ med tillåtelselista.
tema
Sträng
Nej
Standard
Använd temat för programmet Content Advisor mellan default och express. Det har även stöd för @react-spectrum/theme-express.
handleSelection
Funktion
Nej

Anropas med en array med tillgångsobjekt när resurser har valts och knappen Select på spärren klickas. Den här funktionen anropas bara i modal vy. Använd funktionerna handleAssetSelection eller onDrop för spårvyn. Exempel:

handleSelection=(assets: Resurs [])=> {…}

Mer information finns i Val av resurser.

handleAssetSelection
Funktion
Nej

Anropas med en array med objekt när resurserna markeras eller avmarkeras. Detta är användbart när du vill lyssna efter resurser när användaren väljer dem. Exempel:

handleAssetSelection=(assets: Resurs [])=> {…}

Mer information finns i Val av resurser.

onClose
Funktion
Nej
Anropas när knappen Close i modal vy trycks ned. Detta anropas bara i vyn modal och ignoreras i vyn rail.
onFilterSubmit
Funktion
Nej
Anropas med filterobjekt när användaren ändrar olika filtervillkor.
selectionType
Sträng
Nej
Enkelt
Konfiguration för single eller multiple urval av resurser åt gången.
dragOptions.tillåtelselista
boolesk
Nej
Egenskapen används för att tillåta eller neka att resurser som inte kan markeras dras. Se egenskapen dragOptions
aemTierType
Sträng
Nej
Du kan välja om du vill visa resurser från leveransnivå, författarnivå eller både och.

Syntax: aemTierType: "author" "delivery"

Om till exempel båda ["author","delivery"] används, visar databasväxlaren alternativ för både författare och leverans.
handleNavigateToAsset
Funktion
Nej
Det är en återanropsfunktion som hanterar markering av en resurs.
noWrap
Boolean
Nej
Egenskapen noWrap förhindrar att Content Advisor kapslas in i en dialogruta. Om den här egenskapen inte nämns återges dialogvyn som standard.
dialogSize
S, M, L, fullscreen, fullscreenTakeover
Sträng
Valfritt
Du kan styra layouten genom att ange dess storlek med de angivna alternativen.
colorScheme
Sträng (ljus, mörk)
Nej
Den här egenskapen används för att ange temat för ett Content Advisor-program. Du kan välja mellan ljust eller mörkt tema.
filterRepoList
Funktion
Nej
En funktion som tar emot databaslistan och returnerar en filtrerad lista.
expirationOptions
Funktion
Du kan använda mellan följande två egenskaper: getExpiryStatus som anger status för en utgången resurs. Funktionen returnerar EXPIRED, EXPIRING_SOON eller NOT_EXPIRED baserat på förfallodatumet för en resurs som du anger. Se anpassa utgångna resurser. Dessutom kan du använda allowSelectionAndDrag där värdet för funktionen antingen kan vara true eller false. När värdet är false kan resursen som har gått ut inte markeras eller dras på arbetsytan.
showToast
Nej
Det gör att Content Advisor kan visa ett anpassat popup-meddelande för den resurs som har gått ut.
uploadConfig
Objekt
Det är ett objekt som innehåller en anpassad konfiguration för överföringen. Se överföringskonfiguration för användbarhet.
uploadConfig > metadataSchema
Array
Nej
Den här egenskapen är kapslad under egenskapen uploadConfig. Lägg till en array med fält som du anger för att samla in metadata från användaren. Med den här egenskapen kan du även använda dolda metadata som tilldelas till en resurs automatiskt men inte är synliga för användaren.
uploadConfig > onMetadataFormChange
Återanropsfunktion
Nej
Den här egenskapen är kapslad under egenskapen uploadConfig. Det består av property och value. Property är lika med mapToProperty för fältet som skickas från metadataSchema vars värde uppdateras. value är lika med det nya värdet som anges som indata.
uploadConfig > targetUploadPath
Sträng
"/content/dam"
Den här egenskapen är kapslad under egenskapen uploadConfig. Målets överföringssökväg för de filer som har standardvärdet root of the assets database.
uploadConfig > hideUploadButton
Boolean
Falskt
Den ser till att den interna överföringsknappen döljs eller inte. Den här egenskapen är kapslad under egenskapen uploadConfig.
uploadConfig > onUploadStart
Funktion
Nej
Det är en callback-funktion som används för att skicka överföringskällan till Dropbox, OneDrive eller lokal. Syntaxen är (uploadInfo: UploadInfo) => void. Den här egenskapen är kapslad under egenskapen uploadConfig.
uploadConfig > importSettings
Funktion
Det aktiverar stöd för import av resurser från tredje parts källa. sourceTypes använder en array med de importkällor som du vill aktivera. Källorna som stöds är Onedrive och Dropbox. Syntaxen är { sourceTypes?: ImportSourceType[]; apiKey?: string; }. Dessutom är den här egenskapen kapslad under egenskapen uploadConfig.
uploadConfig > onUploadComplete
Funktion
Nej
Det är en återanropsfunktion som används för att skicka filöverföringsstatus bland lyckade, misslyckade eller duplicerade filer. Syntaxen är (uploadStats: UploadStats) => void. Dessutom är den här egenskapen kapslad under egenskapen uploadConfig.
uploadConfig > onFilesChange
Funktion
Nej
Den här egenskapen är kapslad under egenskapen uploadConfig. Det är en återanropsfunktion som används för att visa hur överföringen fungerar när en fil ändras. Den skickar den nya arrayen med filer som väntar på överföring och källtypen för överföringen. Source-typen kan vara null om fel uppstår. Syntaxen är (newFiles: File[], uploadType: UploadType) => void
uploadConfig > uploadingPlaceholder
Sträng
Det är en platshållarbild som ersätter metadataformuläret när en överföring av resursen initieras. Syntaxen är { href: string; alt: string; }. Dessutom är den här egenskapen kapslad under egenskapen uploadConfig.
featureSet
Array
Sträng
Egenskapen featureSet:[ ] används för att aktivera eller inaktivera en viss funktion i Content Advisor-programmet. Om du vill aktivera komponenten eller en funktion kan du skicka ett strängvärde i arrayen eller lämna arrayen tom för att inaktivera tillagda funktioner, och bara ha basfunktionen. Om du till exempel vill aktivera överföringsfunktioner i Content Advisor använder du syntaxen featureSet:["upload"]. På samma sätt kan du använda featureSet:["content-fragments"] för att aktivera innehållsfragment i Content Advisor. Om du vill använda flera funktioner tillsammans är syntaxen featureSet:["upload", "content-fragments"].

ImsAuthProps ims-auth-props

Egenskaperna ImsAuthProps definierar autentiseringsinformationen och det flöde som Content Advisor använder för att hämta en imsToken. Genom att ange dessa egenskaper kan du styra hur autentiseringsflödet ska fungera och registrera avlyssnare för olika autentiseringshändelser.

Egenskapsnamn
Beskrivning
imsClientId
Ett strängvärde som representerar det IMS-klient-ID som används för autentisering. Detta värde tillhandahålls av Adobe och är specifikt för din Adobe AEM CS-organisation.
imsScope
Beskriver de scope som används vid autentisering. Omfattningarna avgör vilken åtkomstnivå programmet har till organisationens resurser. Flera omfång kan avgränsas med kommatecken.
redirectUrl
Representerar den URL där användaren omdirigeras efter autentiseringen. Det här värdet ställs vanligtvis in på programmets aktuella URL. Om redirectUrl inte anges använder ImsAuthService den redirectUrl som används för att registrera imsClientId
modalMode
Ett booleskt värde som anger om autentiseringsflödet ska visas i ett modalt (popup) eller inte. Om värdet är true visas autentiseringsflödet i ett popup-fönster. Om värdet är false visas autentiseringsflödet i en helsidesinläsning. _Note :_för bättre användargränssnitt, du kan dynamiskt styra det här värdet om användaren har webbläsarpopup-fönster inaktiverat.
onImsServiceInitialized
En callback-funktion som anropas när Adobe IMS-autentiseringstjänsten initieras. Den här funktionen har en parameter, service, som är ett objekt som representerar Adobe IMS-tjänsten. Mer information finns i ImsAuthService.
onAccessTokenReceived
En återanropsfunktion som anropas när en imsToken tas emot från Adobe IMS-autentiseringstjänsten. Den här funktionen tar en parameter, imsToken, som är en sträng som representerar åtkomsttoken.
onAccessTokenExpired
En återanropsfunktion som anropas när en åtkomsttoken har upphört att gälla. Den här funktionen används vanligtvis för att utlösa ett nytt autentiseringsflöde för att erhålla en ny åtkomsttoken.
onErrorReceived
En återanropsfunktion som anropas när ett fel inträffar under autentiseringen. Den här funktionen har två parametrar: feltypen och felmeddelandet. Feltypen är en sträng som representerar feltypen och felmeddelandet är en sträng som representerar felmeddelandet.

ImsAuthService ims-auth-service

Klassen ImsAuthService hanterar autentiseringsflödet för Content Advisor. Det ansvarar för att erhålla en imsToken från Adobe IMS-autentiseringstjänsten. imsToken används för att autentisera användaren och auktorisera åtkomst till Adobe Experience Manager som en Cloud Service Assets-databas. ImsAuthService använder egenskaperna ImsAuthProps för att styra autentiseringsflödet och registrera avlyssnare för olika autentiseringshändelser. Du kan använda den praktiska registerAssetsSelectorsAuthService-funktionen för att registrera ImsAuthService-instansen hos Content Advisor. Följande funktioner är tillgängliga för klassen ImsAuthService. Om du använder funktionen registerAssetsSelectorsAuthService behöver du inte anropa dessa funktioner direkt.

Funktionsnamn
Beskrivning
isSignedInUser
Avgör om användaren är inloggad på tjänsten och returnerar ett booleskt värde i enlighet med detta.
getImsToken
Hämtar autentiseringen imsToken för den inloggade användaren, som kan användas för att autentisera begäranden till andra tjänster, som att generera resursåtergivning.
signIn
Initierar inloggningsprocessen för användaren. Den här funktionen använder ImsAuthProps för att visa autentisering i antingen ett popup-fönster eller en helsidesinläsning
signOut
Signerar användaren från tjänsten, gör sin autentiseringstoken ogiltig och kräver att han/hon loggar in igen för att få åtkomst till skyddade resurser. Om du anropar den här funktionen läses den aktuella sidan in igen.
refreshToken
Uppdaterar autentiseringstoken för den inloggade användaren, vilket förhindrar att den upphör att gälla och säkerställer oavbruten åtkomst till skyddade resurser. Returnerar en ny autentiseringstoken som kan användas för efterföljande begäranden.

contentFragmentSelectorProps content-fragment-selector-properties

I contentFragmentSelectorProps kan du konfigurera hur innehållsfragment ska öppnas och visas i Content Advisor. Genom att aktivera funktionen för innehållsfragment i featureSet och tillhandahålla den konfiguration som krävs, kan du sömlöst integrera val av innehållsfragment tillsammans med resurser. Detta gör att användarna kan bläddra bland, söka efter och välja innehållsfragment i samma enhetliga gränssnitt, vilket ger ett enhetligt innehållsurval för olika resurser och strukturerat innehåll.

const assetSelectorProps = {
     featureSet: [
       'upload',            /* Include upload or other featureSet values to ensure no missing functionality */
       'content-fragments', /* Content Fragments pill will be shown */
     ],
     contentFragmentSelectorProps: {
       /* Configures the Content Fragments Pill experience */
       /* ...props @aem-sites/content-fragment-selector MFE supports */
    }
}

<AssetSelector {...assetSelectorProps} />

I contentFragmentSelectorProps kan du ange någon av de egenskaper som är tillgängliga i Egenskaper för innehållsfragmentväljare.

Mer information om hur du integrerar Content Advisor med Angular-, React- och JavaScript-program finns i Integreringsexempel för Content Advisor.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab