API-Vorgänge für Ziel-Endpunkte

WICHTIG

API-Endpunkt: platform.adobe.io/data/core/activation/authoring/destinations

Auf dieser Seite werden alle API-Vorgänge aufgelistet und beschrieben, die Sie mit dem /authoring/destinations API-Endpunkt. Eine Beschreibung der von diesem Endpunkt unterstützten Funktionen finden Sie unter Zielkonfiguration.

Erste Schritte mit Ziel-API-Vorgängen

Bevor Sie fortfahren, lesen Sie bitte die Erste Schritte für wichtige Informationen, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich Informationen zum Abrufen der erforderlichen Authoring-Berechtigung für Ziele und der erforderlichen Kopfzeilen.

Erstellen einer Konfiguration für ein Ziel

Sie können eine neue Zielkonfiguration erstellen, indem Sie eine POST-Anfrage an die /authoring/destinations -Endpunkt.

API-Format

POST /authoring/destinations

Anfrage

Die folgende Anfrage erstellt eine neue Zielkonfiguration, die durch die in der Payload bereitgestellten Parameter konfiguriert wird. Die nachstehende Payload enthält alle Parameter, die vom /authoring/destinations -Endpunkt. Beachten Sie, dass Sie nicht alle Parameter für den Aufruf hinzufügen müssen und dass die Vorlage entsprechend Ihren API-Anforderungen angepasst werden kann.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}
Parameter Typ Beschreibung
name Zeichenfolge Gibt den Titel Ihres Ziels im Experience Platform-Katalog an
description Zeichenfolge Geben Sie eine Beschreibung ein, die Adobe im Zielkatalog der Experience Platform für Ihre Zielkarte verwendet. Ziel für maximal 4-5 Sätze.
status Zeichenfolge Gibt den Lebenszyklusstatus der Zielkarte an. Zulässige Werte sind TEST, PUBLISHED und DELETED. Verwendung TEST wenn Sie Ihr Ziel zum ersten Mal konfigurieren.
customerAuthenticationConfigurations Zeichenfolge Gibt die Konfiguration an, die zum Authentifizieren von Experience Platform-Kunden auf Ihrem Server verwendet wird. Siehe authType unten für gültige Werte.
customerAuthenticationConfigurations.authType Zeichenfolge Akzeptierte Werte sind OAUTH2, BEARER.
customerDataFields.name Zeichenfolge Geben Sie einen Namen für das benutzerdefinierte Feld ein, das Sie einführen.
customerDataFields.type Zeichenfolge Gibt an, welchen Typ von benutzerdefiniertem Feld Sie einführen. Akzeptierte Werte sind string, object, integer
customerDataFields.title Zeichenfolge Gibt den Feldnamen an, wie er von den Kunden in der Experience Platform-Benutzeroberfläche angezeigt wird
customerDataFields.description Zeichenfolge Geben Sie eine Beschreibung für das benutzerdefinierte Feld ein.
customerDataFields.isRequired Boolesch Gibt an, ob dieses Feld im Ziel-Setup-Workflow erforderlich ist.
customerDataFields.enum Zeichenfolge Rendert das benutzerdefinierte Feld als Dropdown-Menü und listet die für den Benutzer verfügbaren Optionen auf.
customerDataFields.pattern Zeichenfolge Erzwingt bei Bedarf ein Muster für das benutzerdefinierte Feld. Verwenden Sie reguläre Ausdrücke, um ein Muster zu erzwingen. Wenn Ihre Kunden-IDs beispielsweise keine Zahlen oder Unterstriche enthalten, geben Sie ^[A-Za-z]+$ in dieses Feld ein.
uiAttributes.documentationLink Zeichenfolge Weitere Informationen finden Sie auf der Dokumentationsseite im Zielkatalog für Ihr Ziel. Verwendung https://www.adobe.com/go/destinations-YOURDESTINATION-en, wobei YOURDESTINATION ist der Name Ihres Ziels. Für ein Ziel mit dem Namen Moviestar würden Sie https://www.adobe.com/go/destinations-moviestar-en.
uiAttributes.category Zeichenfolge Bezieht sich auf die Ihrem Ziel in Adobe Experience Platform zugewiesene Kategorie. Weitere Informationen finden Sie unter Zielkategorien. Verwenden Sie einen der folgenden Werte: 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.
uiAttributes.connectionType Zeichenfolge Server-to-server ist derzeit die einzige verfügbare Option.
uiAttributes.frequency Zeichenfolge Streaming ist derzeit die einzige verfügbare Option.
identityNamespaces.externalId.acceptsAttributes Boolesch Gibt an, ob Ihr Ziel Standardprofilattribute akzeptiert. Normalerweise werden diese Attribute in der Dokumentation unserer Partner hervorgehoben.
identityNamespaces.externalId.acceptsCustomNamespaces Boolesch Gibt an, ob Kunden benutzerdefinierte Namespaces in Ihrem Ziel einrichten können.
identityNamespaces.externalId.allowedAttributesTransformation Zeichenfolge Wird in der Beispielkonfiguration nicht angezeigt. Wird beispielsweise verwendet, wenn die Variable Platform Der Kunde hat einfache E-Mail-Adressen als Attribut und Ihre Plattform akzeptiert nur Hash-E-Mails. Hier geben Sie die Konvertierung an, die angewendet werden muss (konvertieren Sie beispielsweise die E-Mail in Kleinbuchstaben und dann den Hash).
identityNamespaces.externalId.acceptedGlobalNamespaces Wird für Fälle verwendet, in denen Ihre Plattform Standard-Identitäts-Namespaces (z. B. IDFA), sodass Sie Platform-Benutzer darauf beschränken können, nur diese Identitäts-Namespaces auszuwählen.
Wenn Sie acceptedGlobalNamespaceskönnen Sie "requiredTransformation":"sha256(lower($))" in Kleinbuchstaben und Hash-E-Mail-Adressen oder Telefonnummern.
destinationDelivery.authenticationRule Zeichenfolge Gibt an, wie Platform -Kunden stellen eine Verbindung zu Ihrem Ziel her. Akzeptierte Werte sind CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Verwendung CUSTOMER_AUTHENTICATION wenn sich Platform-Kunden über einen Benutzernamen und ein Kennwort, ein Trägertoken oder eine andere Authentifizierungsmethode bei Ihrem System anmelden. Sie würden diese Option beispielsweise auswählen, wenn Sie auch authType: OAUTH2 oder authType:BEARER in customerAuthenticationConfigurations.
  • Verwendung PLATFORM_AUTHENTICATION wenn es ein globales Authentifizierungssystem zwischen Adobe und Ihrem Ziel und der Platform Der Kunde muss keine Authentifizierungsberechtigungen bereitstellen, um eine Verbindung zu Ihrem Ziel herzustellen. In diesem Fall müssen Sie mithilfe der Anmeldeinformationen Konfiguration.
  • Verwendung NONE wenn keine Authentifizierung erforderlich ist, um Daten an Ihre Zielplattform zu senden.
destinationDelivery.destinationServerId Zeichenfolge Die instanceId des Zielservervorlage für dieses Ziel verwendet.
backfillHistoricalProfileData Boolesch Steuert, ob historische Profildaten exportiert werden, wenn Segmente für das Ziel aktiviert werden.
  • true: Platform sendet die historischen Benutzerprofile, die sich für das Segment qualifiziert haben, bevor das Segment aktiviert wird.
  • false: Platform enthält nur Benutzerprofile, die sich für das Segment qualifizieren, nachdem das Segment aktiviert wurde.
segmentMappingConfig.mapUserInput Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow vom Benutzer eingegeben wird.
segmentMappingConfig.mapExperiencePlatformSegmentId Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow die Experience Platform-Segment-ID ist.
segmentMappingConfig.mapExperiencePlatformSegmentName Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow der Experience Platform-Segmentname ist.
segmentMappingConfig.audienceTemplateId Boolesch Die instanceId des Zielgruppen-Metadatenvorlage für dieses Ziel verwendet.
schemaConfig.profileFields Array Beim Hinzufügen vordefinierter Elemente profileFields wie in der obigen Konfiguration gezeigt, können Benutzer die Attribute der Experience Platform den vordefinierten Attributen auf der Zielseite zuordnen.
schemaConfig.profileRequired Boolesch Verwendung true , wenn Benutzer in der Lage sein sollten, Profilattribute von Experience Platform benutzerdefinierten Attributen auf der Zielseite zuzuordnen, wie in der obigen Beispielkonfiguration dargestellt.
schemaConfig.segmentRequired Boolesch Immer verwenden segmentRequired:true.
schemaConfig.identityRequired Boolesch Verwendung true , wenn Sie Benutzer in der Lage sein sollten, Identitäts-Namespaces von Experience Platform Ihrem gewünschten Schema zuzuordnen.
aggregation.aggregationType Klicken Sie entweder auf BEST_EFFORT oder auf CONFIGURABLE_AGGREGATION. Die obige Beispielkonfiguration umfasst BEST_EFFORT aggregation. Beispiel für CONFIGURABLE_AGGREGATION, siehe die Beispielkonfiguration im Abschnitt Zielkonfiguration Dokument. Die für die konfigurierbare Aggregation relevanten Parameter sind nachfolgend in dieser Tabelle beschrieben.
aggregation.bestEffortAggregation.maxUsersPerRequest Ganzzahl Experience Platform kann mehrere exportierte Profile in einem einzigen HTTP-Aufruf aggregieren. Geben Sie die maximale Anzahl von Profilen an, die Ihr Endpunkt in einem einzelnen HTTP-Aufruf erhalten soll. Beachten Sie, dass dies eine Aggregation mit dem besten Aufwand ist. Wenn Sie beispielsweise den Wert 100 angeben, kann Platform eine beliebige Anzahl von Profilen senden, die kleiner als 100 sind.
Wenn Ihr Server nicht mehrere Benutzer pro Anforderung akzeptiert, setzen Sie diesen Wert auf 1.
aggregation.bestEffortAggregation.splitUserById Boolesch Verwenden Sie dieses Flag, wenn der Aufruf an das Ziel nach Identität aufgeteilt werden soll. Setzen Sie dieses Flag auf true Wenn Ihr Server nur eine Identität pro Aufruf akzeptiert, für einen bestimmten Namespace.
aggregation.configurableAggregation.splitUserById Boolesch Siehe Parameter in Beispielkonfiguration here. Verwenden Sie dieses Flag, wenn der Aufruf an das Ziel nach Identität aufgeteilt werden soll. Setzen Sie dieses Flag auf true Wenn Ihr Server nur eine Identität pro Aufruf akzeptiert, für einen bestimmten Namespace.
aggregation.configurableAggregation.maxBatchAgeInSecs Ganzzahl Höchstwert: 3600. Siehe Parameter in Beispielkonfiguration here. Gemeinsam mit maxNumEventsInBatchfestgelegt, wird festgelegt, wie lange die Experience Platform warten soll, bis ein API-Aufruf an Ihren -Endpunkt gesendet wird.
Wenn Sie beispielsweise den Maximalwert für beide Parameter verwenden, wartet die Experience Platform entweder 3600 Sekunden ODER, bis 10.000 qualifizierte Profile vorhanden sind, bevor der API-Aufruf erfolgt (je nachdem, was früher eintritt).
aggregation.configurableAggregation.maxNumEventsInBatch Ganzzahl Höchstwert: 10000. Siehe Parameter in Beispielkonfiguration here. Siehe maxBatchAgeInSecs direkt oben.
aggregation.configurableAggregation.aggregationKey Boolesch Siehe Parameter in Beispielkonfiguration here. Ermöglicht die Aggregation der dem Ziel zugeordneten exportierten Profile anhand der folgenden Parameter:
  • Segment-ID
  • Segmentstatus
  • Identitäts-Namespace
aggregation.configurableAggregation.aggregationKey.includeSegmentId Boolesch Siehe Parameter in Beispielkonfiguration here. Legen Sie hier fest true , wenn Sie Profile gruppieren möchten, die nach Segment-ID in Ihr Ziel exportiert wurden.
aggregation.configurableAggregation.aggregationKey.includeSegmentStatus Boolesch Siehe Parameter in Beispielkonfiguration here. Sie müssen beide includeSegmentId:true und includeSegmentStatus:true , wenn Sie Profile gruppieren möchten, die nach Segment-ID UND Segmentstatus in Ihr Ziel exportiert wurden.
aggregation.configurableAggregation.aggregationKey.includeIdentity Boolesch Siehe Parameter in Beispielkonfiguration here. Legen Sie hier fest true , wenn Sie Profile gruppieren möchten, die nach Ihrem Ziel nach Identitäts-Namespace exportiert wurden.
aggregation.configurableAggregation.aggregationKey.oneIdentityPerGroup Boolesch Siehe Parameter in Beispielkonfiguration here. Verwenden Sie diesen Parameter, um anzugeben, ob die exportierten Profile in Gruppen einer Identität zusammengefasst werden sollen (GAID, IDFA, Telefonnummern, E-Mail usw.).
aggregation.configurableAggregation.aggregationKey.groups Zeichenfolge Siehe Parameter in Beispielkonfiguration here. Erstellen Sie Listen mit Identitätsgruppen, wenn Sie Profile gruppieren möchten, die nach Gruppen von Identitäts-Namespace in Ihr Ziel exportiert wurden. Beispielsweise können Sie Profile, die die IDs für Mobilgeräte IDFA und GAID enthalten, mithilfe der im Beispiel beschriebenen Konfiguration zu einem Aufruf an Ihr Ziel und zu E-Mails zu einem anderen kombinieren.

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Details zur neu erstellten Zielkonfiguration zurück.

Zielkonfigurationen auflisten

Sie können eine Liste aller Zielkonfigurationen für Ihre IMS-Organisation abrufen, indem Sie eine GET-Anfrage an die /authoring/destinations -Endpunkt.

API-Format

GET /authoring/destinations

Anfrage

Mit der folgenden Anfrage wird die Liste der Zielkonfigurationen abgerufen, auf die Sie Zugriff haben, basierend auf der IMS-Organisation und der Sandbox-Konfiguration.

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Die folgende Antwort gibt den HTTP-Status 200 mit einer Liste von Zielkonfigurationen zurück, auf die Sie Zugriff haben, basierend auf der von Ihnen verwendeten IMS-Organisations-ID und dem Sandbox-Namen. One instanceId entspricht der Vorlage für ein Ziel. Die Antwort wird aus Gründen der Kürze abgeschnitten.

{
   "items":[
      {
         "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
         "createdDate":"2020-10-28T06:14:09.784471Z",
         "lastModifiedDate":"2021-06-28T06:14:09.784471Z",
         "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
         "sandboxName":"prod",
         "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
         "name":"Moviestar",
         "description":"Moviestar is a fictional destination, used for this example.",
         "status":"TEST",
         "customerAuthenticationConfigurations":[
            {
               "authType":"BEARER"
            }
         ],
         "customerDataFields":[
            {
               "name":"endpointsInstance",
               "type":"string",
               "title":"Select Endpoint",
               "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
               "isRequired":true,
               "enum":[
                  "US",
                  "EU",
                  "APAC",
                  "NZ"
               ]
            },
            {
               "name":"customerID",
               "type":"string",
               "title":"Moviestar Customer ID",
               "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
               "isRequired":true,
               "pattern":"^[A-Za-z]+$"
            }
         ],
         "uiAttributes":{
            "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
            "category":"mobile",
            "connectionType":"Server-to-server",
            "frequency":"Streaming"
         },
         "identityNamespaces":{
            "external_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true,
               "acceptedGlobalNamespaces":{
                  "Email":{
                     
                  }
               }
            },
            "another_id":{
               "acceptsAttributes":true,
               "acceptsCustomNamespaces":true
            }
         },
         "segmentMappingConfig":{
            "mapExperiencePlatformSegmentName":false,
            "mapExperiencePlatformSegmentId":false,
            "mapUserInput":false,
            "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
         },
         "schemaConfig":{
            "profileFields":[
               {
                  "name":"a_custom_attribute",
                  "title":"a_custom_attribute",
                  "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
                  "type":"string",
                  "isRequired":false,
                  "readOnly":false,
                  "hidden":false
               }
            ],
            "profileRequired":true,
            "segmentRequired":true,
            "identityRequired":true
         },
         "aggregation":{
            "aggregationType":"BEST_EFFORT",
            "bestEffortAggregation":{
               "maxUsersPerRequest":10,
               "splitUserById":false
            }
         },
         "destinationDelivery":[
            {
               "authenticationRule":"CUSTOMER_AUTHENTICATION",
               "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
            }
         ],
         "destConfigId":"410631b8-f6b3-4b7c-82da-7998aa3f327c",
         "backfillHistoricalProfileData":true
      }
   ]
}
    
Parameter Typ Beschreibung
name Zeichenfolge Gibt den Titel Ihres Ziels im Experience Platform-Katalog an.
description Zeichenfolge Geben Sie eine Beschreibung ein, die Adobe im Zielkatalog der Experience Platform für Ihre Zielkarte verwendet. Ziel für maximal 4-5 Sätze.
status Zeichenfolge Gibt den Lebenszyklusstatus der Zielkarte an. Zulässige Werte sind TEST, PUBLISHED und DELETED. Verwendung TEST wenn Sie Ihr Ziel zum ersten Mal konfigurieren.
customerAuthenticationConfigurations Zeichenfolge Gibt die Konfiguration an, die zum Authentifizieren von Experience Platform-Kunden auf Ihrem Server verwendet wird. Siehe authType unten für gültige Werte.
customerAuthenticationConfigurations.authType Zeichenfolge Akzeptierte Werte sind OAUTH2, BEARER.
customerDataFields.name Zeichenfolge Geben Sie einen Namen für das benutzerdefinierte Feld ein, das Sie einführen.
customerDataFields.type Zeichenfolge Gibt an, welchen Typ von benutzerdefiniertem Feld Sie einführen. Akzeptierte Werte sind string, object, integer
customerDataFields.title Zeichenfolge Gibt den Feldnamen an, wie er von den Kunden in der Experience Platform-Benutzeroberfläche angezeigt wird
customerDataFields.description Zeichenfolge Geben Sie eine Beschreibung für das benutzerdefinierte Feld ein.
customerDataFields.isRequired Boolesch Gibt an, ob dieses Feld im Ziel-Setup-Workflow erforderlich ist.
customerDataFields.enum Zeichenfolge Rendert das benutzerdefinierte Feld als Dropdown-Menü und listet die für den Benutzer verfügbaren Optionen auf.
customerDataFields.pattern Zeichenfolge Erzwingt bei Bedarf ein Muster für das benutzerdefinierte Feld. Verwenden Sie reguläre Ausdrücke, um ein Muster zu erzwingen. Wenn Ihre Kunden-IDs beispielsweise keine Zahlen oder Unterstriche enthalten, geben Sie ^[A-Za-z]+$ in dieses Feld ein.
uiAttributes.documentationLink Zeichenfolge Weitere Informationen finden Sie auf der Dokumentationsseite im Zielkatalog für Ihr Ziel. Verwendung https://www.adobe.com/go/destinations-YOURDESTINATION-en, wobei YOURDESTINATION ist der Name Ihres Ziels. Für ein Ziel mit dem Namen Moviestar würden Sie https://www.adobe.com/go/destinations-moviestar-en
uiAttributes.category Zeichenfolge Bezieht sich auf die Ihrem Ziel in Adobe Experience Platform zugewiesene Kategorie. Weitere Informationen finden Sie unter Zielkategorien. Verwenden Sie einen der folgenden Werte: 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
uiAttributes.connectionType Zeichenfolge Server-to-server ist derzeit die einzige verfügbare Option.
uiAttributes.frequency Zeichenfolge Streaming ist derzeit die einzige verfügbare Option.
identityNamespaces.externalId.acceptsAttributes Boolesch Gibt an, ob Ihr Ziel Standardprofilattribute akzeptiert. Normalerweise werden diese Attribute in der Dokumentation unserer Partner hervorgehoben.
identityNamespaces.externalId.acceptsCustomNamespaces Boolesch Gibt an, ob Kunden benutzerdefinierte Namespaces in Ihrem Ziel einrichten können. Mehr dazu benutzerdefinierte Namespaces in Adobe Experience Platform.
identityNamespaces.externalId.allowedAttributesTransformation Zeichenfolge Wird in der Beispielkonfiguration nicht angezeigt. Wird beispielsweise verwendet, wenn die Variable Platform Der Kunde hat einfache E-Mail-Adressen als Attribut und Ihre Plattform akzeptiert nur Hash-E-Mails. Hier geben Sie die Konvertierung an, die angewendet werden muss (konvertieren Sie beispielsweise die E-Mail in Kleinbuchstaben und dann den Hash).
identityNamespaces.externalId.acceptedGlobalNamespaces Wird für Fälle verwendet, in denen Ihre Plattform Standard-Identitäts-Namespaces (z. B. IDFA), sodass Sie Platform-Benutzer darauf beschränken können, nur diese Identitäts-Namespaces auszuwählen.
destinationDelivery.authenticationRule Zeichenfolge Gibt an, wie Platform -Kunden stellen eine Verbindung zu Ihrem Ziel her. Akzeptierte Werte sind CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Verwendung CUSTOMER_AUTHENTICATION wenn sich Platform-Kunden über einen Benutzernamen und ein Kennwort, ein Trägertoken oder eine andere Authentifizierungsmethode bei Ihrem System anmelden. Sie würden diese Option beispielsweise auswählen, wenn Sie auch authType: OAUTH2 oder authType:BEARER in customerAuthenticationConfigurations.
  • Verwendung PLATFORM_AUTHENTICATION wenn es ein globales Authentifizierungssystem zwischen Adobe und Ihrem Ziel und der Platform Der Kunde muss keine Authentifizierungsberechtigungen bereitstellen, um eine Verbindung zu Ihrem Ziel herzustellen. In diesem Fall müssen Sie mithilfe der Anmeldeinformationen Konfiguration.
  • Verwendung NONE wenn keine Authentifizierung erforderlich ist, um Daten an Ihre Zielplattform zu senden.
destinationDelivery.destinationServerId Zeichenfolge Die instanceId des Zielservervorlage für dieses Ziel verwendet.
destConfigId Zeichenfolge Dieses Feld wird automatisch generiert und erfordert keine Eingabe.
backfillHistoricalProfileData Boolesch Steuert, ob historische Profildaten exportiert werden, wenn Segmente für das Ziel aktiviert werden.
  • true: Platform sendet die historischen Benutzerprofile, die sich für das Segment qualifiziert haben, bevor das Segment aktiviert wird.
  • false: Platform enthält nur Benutzerprofile, die sich für das Segment qualifizieren, nachdem das Segment aktiviert wurde.
segmentMappingConfig.mapUserInput Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow vom Benutzer eingegeben wird.
segmentMappingConfig.mapExperiencePlatformSegmentId Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow die Experience Platform-Segment-ID ist.
segmentMappingConfig.mapExperiencePlatformSegmentName Boolesch Steuert, ob die Segmentzuordnungs-ID im Zielaktivierungs-Workflow der Experience Platform-Segmentname ist.
segmentMappingConfig.audienceTemplateId Boolesch Die instanceId des Zielgruppen-Metadatenvorlage für dieses Ziel verwendet. Lesen Sie zum Einrichten einer Audience-Metadatenvorlage die API-Referenz für Zielgruppen-Metadaten.

Vorhandene Zielkonfiguration aktualisieren

Sie können eine bestehende Zielkonfiguration aktualisieren, indem Sie eine PUT-Anfrage an die /authoring/destinations -Endpunkt und geben die Instanz-ID der Zielkonfiguration an, die Sie aktualisieren möchten. Geben Sie im Text des Aufrufs die aktualisierte Zielkonfiguration an.

API-Format

PUT /authoring/destinations/{INSTANCE_ID}
Parameter Beschreibung
{INSTANCE_ID} Die ID der Zielkonfiguration, die Sie aktualisieren möchten.

Anfrage

Die folgende Anfrage aktualisiert eine vorhandene Zielkonfiguration, die durch die in der Payload bereitgestellten Parameter konfiguriert wird. Im folgenden Beispielaufruf aktualisieren wir die Konfiguration früher erstellt um nun GAID-, IDFA- und Hash-E-Mail-IDs als Identitäts-Namespaces zu akzeptieren.

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-04-28T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Abrufen einer bestimmten Zielkonfiguration

Sie können detaillierte Informationen zu einer bestimmten Zielkonfiguration abrufen, indem Sie eine GET-Anfrage an die /authoring/destinations -Endpunkt und geben die Instanz-ID der Zielkonfiguration an, die Sie abrufen möchten.

API-Format

GET /authoring/destinations/{INSTANCE_ID}
Parameter Beschreibung
{INSTANCE_ID} Die ID der Zielkonfiguration, die Sie abrufen möchten.

Anfrage

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit detaillierten Informationen zur angegebenen Zielkonfiguration zurück.

{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-06-04T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
               
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Löschen einer bestimmten Zielkonfiguration

Sie können die angegebene Zielkonfiguration löschen, indem Sie eine DELETE-Anfrage an die /authoring/destinations -Endpunkt und geben Sie die Kennung der Zielkonfiguration an, die Sie im Anfragepfad löschen möchten.

API-Format

DELETE /authoring/destinations/{INSTANCE_ID}
Parameter Beschreibung
{INSTANCE_ID} Die id der Zielkonfiguration, die Sie löschen möchten.

Anfrage

curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 zusammen mit einer leeren HTTP-Antwort zurück.

Umgang mit API-Fehlern

Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen der Experience Platform API-Fehlermeldung. Siehe API-Statuscodes und Fehler in der Anfragekopfzeile im Handbuch zur Fehlerbehebung bei Platform.

Nächste Schritte

Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie Ihr Ziel mithilfe der /authoring/destinations API-Endpunkt. Lesen Verwendung von Destination SDK zum Konfigurieren Ihres Ziels um zu verstehen, wo dieser Schritt in den Prozess der Konfiguration Ihres Ziels passt.

Auf dieser Seite