[AEM Assets]{class="badge positive" title="van toepassing op AEM Assets)."}

Installatie en eigenschappen van Content Advisor content-advisor-installation-properties

Content Advisor is ook beschikbaar voor integratie met niet-Adobe (derde partij) toepassingen, waardoor de intelligente detectie van bedrijfsmiddelen verder gaat dan Adobe-toepassingen. Dezelfde uitgebreide functieset, zoals zoeken op basis van AI, contextbewuste aanbevelingen, korte detectie van campagnes, toegang tot dynamische media-uitvoeringen, detectie van inhoudsfragmenten, filters en metagegevens van elementen, wordt ondersteund in integratie van derden.

Vereisten prereqs

U moet de volgende communicatiemethoden gebruiken:

  • De hosttoepassing wordt uitgevoerd op HTTPS.
  • U kunt de toepassing niet uitvoeren op localhost . Als u Content Advisor op uw lokale computer wilt integreren, moet u bijvoorbeeld een aangepast domein maken [https://<your_campany>.localhost.com:<port_number>] en dit aangepaste domein toevoegen in de redirectUrl list .
  • U kunt clientID configureren en toevoegen aan de omgevingsvariabele van de AEM Cloud-service met de respectievelijke imsClientId .
  • De lijst van het werkingsgebied IMS moet in de omgevingsconfiguratie worden bepaald.
  • De URL van de toepassing bevindt zich in de lijst van gewenste personen van de IMS-client voor het doorsturen van URL's.
  • De IMS-aanmeldstroom wordt geconfigureerd en weergegeven met een pop-up in de webbrowser. Daarom moeten pop-ups worden ingeschakeld of toegestaan in de doelbrowser.

Gebruik de bovenstaande voorwaarden als u de IMS-verificatieworkflow van Content Advisor nodig hebt. Als u al bent geverifieerd met de IMS-workflow, kunt u in plaats daarvan de IMS-informatie toevoegen.

IMPORTANT
Deze opslagplaats is bedoeld als aanvullende documentatie waarin de beschikbare API's en gebruiksvoorbeelden voor de integratie van Content Advisor worden beschreven. Voordat u Content Advisor probeert te installeren of te gebruiken, moet u ervoor zorgen dat uw organisatie beschikt over de toegang tot Content Advisor als onderdeel van het Experience Manager Assets as a Cloud Service-profiel. Als u niet provisioned bent, kunt u deze componenten niet integreren of gebruiken. Om levering te verzoeken, zou uw programma admin een steunkaartje moeten opheffen dat als P2 van Admin Console wordt gemerkt en de volgende informatie omvatten:
  • Domeinnamen waarbij de integrerende toepassing wordt gehost.
  • Na provisioning ontvangt uw organisatie imsClientId , imsScope en een redirectUrl die overeenkomen met de gevraagde omgevingen die essentieel zijn voor de configuratie van Content Advisor. Zonder deze geldige eigenschappen kunt u de installatiestappen niet uitvoeren.

Installatie content-advisor-installation

De Adviseur van de inhoud is beschikbaar via zowel ESM CDN (bijvoorbeeld, ​ esm.sh ​/​ kabel ​) als ​ UMD ​ versie.

In browsers die {versie 0} gebruiken UMD (geadviseerd):

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

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

In browsers met import maps steun gebruikend versie van ESM CDN:

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

In Deno/de Federatie van de Module van het Pakket gebruikend versie van ESM CDN:

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

Eigenschappen van Content Advisor content-advisor-propertiess

U kunt de eigenschappen van de Adviseur van de Inhoud gebruiken om de manier aan te passen de Adviseur van de Inhoud wordt teruggegeven. In de volgende tabel worden de eigenschappen weergegeven die u kunt gebruiken om Content Advisor aan te passen en te gebruiken.

Eigenschap
Type
Vereist
Standaard
Beschrijving
spoorstaaf
Boolean
Nee
Onwaar
Indien gemarkeerd true , wordt Content Advisor weergegeven in een linkerspoorweergave. Als deze is gemarkeerd met false , wordt de Content Advisor weergegeven in de modale weergave.
imsOrg
String
Ja
Adobe Identity Management System (IMS)-id die tijdens de provisioning Adobe Experience Manager is toegewezen als een Cloud Service voor uw organisatie. De imsOrg -toets is vereist om te verifiëren of de organisatie waartoe u toegang hebt, onder Adobe IMS valt of niet.
imsToken
String
Nee
IMS-token voor toonder die wordt gebruikt voor verificatie. imsToken is vereist als u een Adobe -toepassing voor de integratie gebruikt.
apiKey
String
Nee
API-sleutel voor toegang tot de AEM Discovery-service. apiKey is vereist als u een Adobe -toepassingsintegratie gebruikt.
externalBrief
String
Nee
Hiermee kunt u een kort campagneretekstdocument uploaden om relevante elementen te detecteren zonder handmatig zoektrefwoorden in te voeren. Content Advisor analyseert de informatie in de campagneresamenvatting om inzicht te krijgen in de intentie van de campagne en raadt relevante middelen aan die beschikbaar zijn in AEM Assets.
filterSchema
Array
Nee
Model dat wordt gebruikt om filtereigenschappen te vormen. Dit is handig wanneer u bepaalde filteropties in Content Advisor wilt beperken.
filterFormProps
Object
Nee
Geef de filtereigenschappen op die u nodig hebt om de zoekopdracht te verfijnen. Voor! Voorbeeld: MIME-type JPG, PNG, GIF.
selectedAssets
Array <Object>
Nee
Geef de geselecteerde Assets op wanneer de Content Advisor wordt weergegeven. Een array van objecten is vereist die een id-eigenschap van de elementen bevat. [{id: 'urn:234}, {id: 'urn:555'}] Een element moet bijvoorbeeld beschikbaar zijn in de huidige map. Als u een andere map moet gebruiken, geeft u ook een waarde op voor de eigenschap path .
acvConfig
Object
Nee
De bezit van de Mening van de Inzameling van activa dat voorwerp bevat dat douaneconfiguratie bevat om gebreken met voeten te treden. Deze eigenschap wordt ook gebruikt met de eigenschap rail om de weergave per spoor van de viewer voor elementen in te schakelen.
i18nSymbols
Object<{ id?: string, defaultMessage?: string, description?: string}>
Nee
Als de OOTB-vertalingen onvoldoende zijn voor de behoeften van uw toepassing, kunt u een interface beschikbaar maken waarmee u uw eigen gelokaliseerde waarden kunt doorgeven via de i18nSymbols -proxy. Als u een waarde door deze interface doorgeeft, overschrijft u de standaardvertalingen die worden geleverd en gebruikt u in plaats daarvan uw eigen vertaling. Om de opheffing uit te voeren, moet u een geldig 🔗 voorwerp van de Beschrijver van het Bericht tot de sleutel van i18nSymbols overgaan die u wilt met voeten treden.
intl
Object
Nee
Content Advisor biedt standaard OTB-vertalingen. U kunt de vertaaltaal selecteren door een geldige tekenreeks voor de landinstelling op te geven via de eigenschap intl.locale . Bijvoorbeeld: intl={{ locale: "es-es" }}

de gesteunde scènekoorden volgen ​ ISO 639 - Codes ​ voor de vertegenwoordiging van namen van taalnormen.

Lijst met ondersteunde landinstellingen: Engels - 'en-us' (standaard) Spaans - 'es-es' Duits - 'de-de' Frans - 'fr-fr' Italiaans - 'it-it' Japans - 'ja-jp' Koreaans - 'ko-kr' Portugees - 'pt-br' Chinees (traditioneel) - 'zh-cn' Chinees (Taiwan) - 'zh-tw'
repositoryId
String
Nee
''
Opslagplaats waar de Inhoud Adviseur de inhoud laadt.
additionalAemSolutions
Array<string>
Nee
[ ]
Hiermee kunt u een lijst met extra AEM-opslagplaatsen toevoegen. Als deze eigenschap geen informatie bevat, worden alleen mediawisselaars of AEM Assets-opslagruimten in aanmerking genomen.
hideTreeNav
Boolean
Nee
Hiermee geeft u op of de zijbalk met boomnavigatie met elementen moet worden weergegeven of verborgen. Het wordt alleen in modale zin gebruikt en daarom heeft dit onroerend goed geen effect in de spoorwegen.
onDrop
Functie
Nee
De functie Bij neerzetten wordt gebruikt om een middel te slepen en op een aangewezen dalingsgebied vrij te geven. Het maakt interactieve gebruikersinterfaces mogelijk waarin elementen naadloos kunnen worden verplaatst en verwerkt.
dropOptions
{allowList?: Object}
Nee
Vormt dalingsopties gebruikend "lijst van gewenste personen".
thema
String
Nee
Standaard
Pas thema toe op de toepassing Content Advisor tussen default en express . Deze ondersteunt ook @react-spectrum/theme-express .
handleSelection
Functie
Nee

Wordt aangeroepen met een array van elementen wanneer elementen worden geselecteerd en op de knop Select op het modale object wordt geklikt. Deze functie wordt alleen aangeroepen in de modale weergave. Gebruik voor de rasterweergave de functies handleAssetSelection of onDrop . Voorbeeld:

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

Zie ​ selectie van activa ​ voor details.

handleAssetSelection
Functie
Nee

Wordt aangeroepen met een array van items wanneer de elementen worden geselecteerd of niet geselecteerd. Dit is handig wanneer u naar elementen wilt luisteren terwijl de gebruiker deze selecteert. Voorbeeld:

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

Zie ​ selectie van activa ​ voor details.

onClose
Functie
Nee
Wordt aangeroepen wanneer op de knop Close in de modale weergave wordt gedrukt. Dit wordt alleen aangeroepen in de modal -weergave en wordt in rail -weergave genegeerd.
onFilterSubmit
Functie
Nee
Wordt aangeroepen met filteritems wanneer de gebruiker andere filtercriteria wijzigt.
selectionType
String
Nee
Enkel
Configuratie voor single of multiple selectie van elementen tegelijk.
dragOptions.lijst van gewenste personen
boolean
Nee
De eigenschap wordt gebruikt om het slepen van elementen die niet kunnen worden geselecteerd toe te staan of te weigeren. Zie ​ dragOptions Bezit ​
nameTierType
String
Nee
Hiermee kunt u selecteren of u elementen uit de leveringslaag, de auteurslaag of beide wilt weergeven.

Syntaxis: aemTierType: "author" "delivery"

Als bijvoorbeeld beide ["author","delivery"] worden gebruikt, worden opties voor zowel auteur als levering weergegeven met de repository switch.
handleNavigateToAsset
Functie
Nee
Het is een callback functie om selectie van activa te behandelen.
noWrap
Boolean
Nee
Het noWrap bezit verhindert de Adviseur van de Inhoud in een dialoog worden verpakt. Als dit bezit niet wordt vermeld, geeft het de mening van de Dialoog door gebrek terug.
dialogSize
S, M, L, fullscreen, fullscreenOvernames
String
Optioneel
U kunt de lay-out bepalen door zijn grootte te specificeren gebruikend de bepaalde opties.
colorScheme
Tekenreeks (licht, donker)
Nee
Deze eigenschap wordt gebruikt om het thema van een toepassing Content Advisor in te stellen. U kunt kiezen tussen licht of donker thema.
filterRepoList
Functie
Nee
Een functie die de opslagplaats lijst ontvangt en een gefilterde lijst terugkeert.
endOptions
Functie
U kunt tussen de volgende twee eigenschappen gebruiken: getExpiryStatus die status van een verlopen activa verstrekt. De functie retourneert EXPIRED , EXPIRING_SOON of NOT_EXPIRED op basis van de vervaldatum van een element dat u opgeeft. Zie ​ verlopen activa ​ aanpassen. Bovendien, kunt u allowSelectionAndDrag gebruiken waarin de waarde van de functie of true of false kan zijn. Wanneer de waarde is ingesteld op false , kan het verlopen element niet worden geselecteerd of gesleept op het canvas.
showToast
Nee
Hiermee kan Content Advisor een aangepast pop-upbericht voor het verlopen element weergeven.
uploadConfig
Object
Het is een object dat een aangepaste configuratie voor het uploaden bevat. Zie ​ configuratie ​ voor de bruikbaarheid uploaden.
uploadConfig > metadataSchema
Array
Nee
Deze eigenschap is genest onder de eigenschap uploadConfig . Voeg een array van velden toe die u opgeeft om metagegevens van de gebruiker te verzamelen. Met deze eigenschap kunt u ook verborgen metagegevens gebruiken die automatisch aan een element worden toegewezen, maar die niet zichtbaar zijn voor de gebruiker.
uploadConfig > onMetadataFormChange
Callback-functie
Nee
Deze eigenschap is genest onder de eigenschap uploadConfig . Deze bestaat uit property en value . Property evenaart mapToProperty van het gebied dat van wordt overgegaan metadataSchema de waarvan waarde wordt bijgewerkt. Terwijl, value evenaart de nieuwe waarde als input wordt verstrekt.
uploadConfig > targetUploadPath
String
"/content/dam"
Deze eigenschap is genest onder de eigenschap uploadConfig . Het doeluploadpad voor de bestanden die standaard de hoofdmap van de gegevensopslagruimte vormen.
uploadConfig > hideUploadButton
Boolean
Onwaar
Hiermee zorgt u ervoor dat de interne knop voor uploaden verborgen moet zijn of niet. Deze eigenschap is genest onder de eigenschap uploadConfig .
uploadConfig > onUploadStart
Functie
Nee
Dit is een callback-functie die wordt gebruikt om de uploadbron door te geven tussen Dropbox, OneDrive of local. De syntaxis is (uploadInfo: UploadInfo) => void . Deze eigenschap is genest onder de eigenschap uploadConfig .
uploadConfig > importSettings
Functie
Hiermee wordt ondersteuning ingeschakeld voor het importeren van elementen van derden. sourceTypes gebruikt een array met de importbronnen die u wilt inschakelen. De ondersteunde bronnen zijn Onedrive en Dropbox. De syntaxis is { sourceTypes?: ImportSourceType[]; apiKey?: string; } . Bovendien is deze eigenschap genest onder de eigenschap uploadConfig .
uploadConfig > onUploadComplete
Functie
Nee
Dit is een callback-functie die wordt gebruikt om de status voor het uploaden van een bestand door te geven onder geslaagd, mislukt of gedupliceerd. De syntaxis is (uploadStats: UploadStats) => void . Bovendien is deze eigenschap genest onder de eigenschap uploadConfig .
uploadConfig > onFilesChange
Functie
Nee
Deze eigenschap is genest onder de eigenschap uploadConfig . Het is een callback functie die wordt gebruikt om het gedrag van te tonen upload wanneer een dossier wordt veranderd. De nieuwe array met bestanden die moeten worden geüpload en het brontype van de upload worden doorgegeven. Source-type kan null zijn in het geval van een fout. De syntaxis is (newFiles: File[], uploadType: UploadType) => void
uploadConfig > uploadingPlaceholder
String
Het is een plaatsaanduidingsafbeelding die het metagegevensformulier vervangt wanneer het uploaden van het element wordt gestart. De syntaxis is { href: string; alt: string; } en deze eigenschap is bovendien genest onder de eigenschap uploadConfig .
featureSet
Array
String
De eigenschap featureSet:[ ] wordt gebruikt om een bepaalde functionaliteit in of uit te schakelen in de toepassing Content Advisor. Om de component of een eigenschap toe te laten, kunt u een koordwaarde in de serie overgaan of de serie leeg verlaten om toegevoegde eigenschappen onbruikbaar te maken, en enkel de basisfunctionaliteit te hebben. Gebruik bijvoorbeeld de syntaxis featureSet:["upload"] als u uploadfunctionaliteit wilt inschakelen in de Content Advisor. Op dezelfde manier kunt u featureSet:["content-fragments"] gebruiken om Content Fragments in de Adviseur van de Inhoud toe te laten. Om veelvoudige eigenschappen samen te gebruiken, is de syntaxis featureSet:[ "upload", "content-fragments"].

ImsAuthProps ims-auth-props

De ImsAuthProps -eigenschappen definiëren de verificatiegegevens en -stroom die de Content Advisor gebruikt om een imsToken -element te verkrijgen. Door deze eigenschappen te plaatsen, kunt u controleren hoe de authentificatiestroom zich zou moeten gedragen en luisteraars voor diverse authentificatiegebeurtenissen registreren.

Eigenschapnaam
Beschrijving
imsClientId
Een tekenreekswaarde die de IMS client-id vertegenwoordigt die voor verificatiedoeleinden wordt gebruikt. Deze waarde wordt geleverd door Adobe en is specifiek voor uw Adobe AEM CS-organisatie.
imsScope
Beschrijft het werkingsgebied dat in authentificatie wordt gebruikt. Het werkingsgebied bepaalt het niveau van toegang dat de toepassing aan uw organisatiemiddelen heeft. Meerdere bereiken kunnen worden gescheiden door komma's.
redirectUrl
Geeft de URL aan waar de gebruiker na verificatie opnieuw wordt omgeleid. Deze waarde wordt doorgaans ingesteld op de huidige URL van de toepassing. Als een redirectUrl niet wordt opgegeven, gebruikt ImsAuthService de redirectUrl die wordt gebruikt om de imsClientId te registreren
modalMode
Een Booleaanse waarde die aangeeft of de verificatiestroom al dan niet moet worden weergegeven in een modaal (pop-upmenu). Indien ingesteld op true , wordt de verificatiestroom weergegeven in een pop-up. Indien ingesteld op false , wordt de verificatiestroom weergegeven in een volledige pagina die opnieuw wordt geladen. _Nota :_voor betere UX, kunt u deze waarde dynamisch controleren als de gebruiker browser pop-up gehandicapt heeft.
onImsServiceInitialized
Een callback-functie die wordt aangeroepen wanneer de Adobe IMS-verificatieservice wordt geïnitialiseerd. Deze functie heeft één parameter, service , die een object is dat de Adobe IMS-service vertegenwoordigt. Zie ImsAuthService voor meer informatie.
onAccessTokenReceived
Een callback-functie die wordt aangeroepen wanneer een imsToken wordt ontvangen van de Adobe IMS-verificatieservice. Deze functie heeft één parameter, imsToken, die een tekenreeks is die het toegangstoken vertegenwoordigt.
onAccessTokenExpired
Een callback functie die wordt geroepen wanneer een toegangstoken is verlopen. Deze functie wordt typisch gebruikt om een nieuwe authentificatiestroom teweeg te brengen om een nieuw toegangstoken te verkrijgen.
onErrorReceived
Een callback functie die wordt geroepen wanneer een fout tijdens authentificatie voorkomt. Deze functie heeft twee parameters: het fouttype en foutbericht. Het fouttype is een tekenreeks die het type fout vertegenwoordigt en het foutbericht is een tekenreeks die het foutbericht vertegenwoordigt.

ImsAuthService ims-auth-service

De ImsAuthService -klasse handelt de verificatiestroom voor de Content Advisor af. Het is verantwoordelijk voor het verkrijgen van een imsToken van de Adobe IMS-verificatieservice. De imsToken wordt gebruikt om de gebruiker te verifiëren en toegang tot de Adobe Experience Manager toe te staan als een Cloud Service Assets-opslagplaats. ImsAuthService gebruikt de ImsAuthProps eigenschappen om de authentificatiestroom te controleren en luisteraars voor diverse authentificatiegebeurtenissen te registreren. U kunt de geschikte registerAssetsSelectorsAuthService functie gebruiken om de ImsAuthService instantie met de Adviseur van de Inhoud te registreren. De volgende functies zijn beschikbaar voor de ImsAuthService -klasse. Nochtans, als u de registerAssetsSelectorsAuthService functie gebruikt, te hoeven u deze functies niet direct te roepen.

Functienaam
Beschrijving
isSignedInUser
Bepaalt of de gebruiker momenteel binnen aan de dienst wordt ondertekend en een booleaanse waarde dienovereenkomstig terugkeert.
getImsToken
Haalt de verificatie imsToken op voor de momenteel aangemelde gebruiker, die kan worden gebruikt om aanvragen voor andere services, zoals het genereren van asset_rendition, te verifiëren.
signIn
Hiermee wordt het aanmeldingsproces voor de gebruiker gestart. Deze functie gebruikt ImsAuthProps om verificatie weer te geven in een pop-up of een volledige pagina die opnieuw wordt geladen
signOut
Signs the user out of the service, invalidating their authentication token and require them to sign in again to access protected resources. Als u deze functie aanroept, wordt de huidige pagina opnieuw geladen.
refreshToken
Verfrist het authentificatietoken voor de momenteel ondertekende gebruiker, verhinderend het en ononderbroken toegang tot beschermde middelen te verzekeren. Keert een nieuw authentificatietoken terug dat voor verdere verzoeken kan worden gebruikt.

contentFragmentSelectorProps content-fragment-selector-properties

Met contentFragmentSelectorProps kunt u configureren hoe Inhoudsfragmenten worden benaderd en weergegeven in de Inhoudsadviseur. Door de functie voor inhoudfragmenten in de featureSet in te schakelen en de vereiste configuratie te bieden, kunt u selectie van inhoudsfragmenten naadloos naast elementen integreren. Op deze manier kunnen gebruikers door meerdere inhoudsfragmenten bladeren, deze doorzoeken en deze selecteren binnen dezelfde interface, zodat de inhoud op alle elementen en gestructureerde inhoud consistent kan worden geselecteerd.

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} />

In contentFragmentSelectorProps, kunt u om het even welke eigenschappen noemen beschikbaar bij ​ de eigenschappen van de Selecteur van het Fragment van de Inhoud ​.

Voor informatie over hoe te om de Adviseur van de Inhoud met Angular te integreren, Reageer, en de toepassingen van JavaScript, verwijs naar ​ de integratievoorbeelden van de Adviseur van de Inhoud ​.

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