DokumentationAdobe Campaign v8

[BEGRENZTE VERFÜGBARKEIT]{class="badge informative" title="Auf Campaign Standard migrierte Benutzer beschränkt"}

Filter filtering

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Experte
  • Entwickler

Abrufen von Filtermetadaten

Für jede Ressource stehen Filter zur Verfügung. Um die mit einer Ressource verknüpften Filter zu ermitteln, müssen Sie eine GET-Anfrage für die Metadaten der Ressource durchführen. Die Anfrage gibt die URL zurück, unter der alle Filter für eine bestimmte Ressource definiert sind. Weiterführende Informationen zu Metadaten finden Sie in diesem Abschnitt.

Um die Metadaten eines Filters und die jeweilige Verwendungsweise zu ermitteln, müssen Sie eine GET-Anfrage für die zuvor zurückgegebene URL durchführen.

Beispielanfrage

Die folgenden beispielhaften Payloads zeigen, wie die "byText"-Filtermetadaten für die "Profil"-Ressource abgerufen werden. Führen Sie zuerst eine GET-Anfrage für die Metadaten der Ressource "Profil" durch.

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

Diese gibt die URL zurück, unter der die Filter beschrieben werden.

{
"filters": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>/filters/"
    }
  }

Führen Sie eine GET-Anfrage für die URL aus. Sie erhalten eine Liste der Filter für die Ressource "Profil" mit den jedem Filter zugeordneten Metadaten.

{
"birthday": {
        "PKey": "@FL-CbDFXbnHbXcVpeCGWL46VXJLn1LqxLMPagt2vz8sCxQ52lvB15KiUaxXkxJYQw-tZXYrgUWG6K8QcB4gxVY9RKoba5bRFY3294YFshDmorRr8",
        "category": "0150_profile",
        "condition": ...,
        "data": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/birthday?type=$value&precision=$value&operator=$value&day=$value&month=$value&includeStart=$value&endDay=$value&endMonth=$value&includeEnd=$value&relativeValue=$value&nextUnitsValue=$value&previousUnitsValue=$value",
        "formType": "webPage",
        "fragmentName": "",
        "label": "Birthday",
}

Struktur von Filtermetadaten

Jeder Filter weist dieselbe Metadatenstruktur auf:

  • Die Felder @formType und @webPage sind technische Felder.
  • Das Feld Daten enthält ein Beispiel zur Verwendung des Filters.
  • Der Knoten Metadaten beschreibt die Filterparameter.
  • Der Knoten Bedingungen beschreibt, was der Filter tun soll. Die im Metadaten-Knoten beschriebenen Filterparameter dienen zum Erstellen von Filterbedingungen. Wenn enabledIf wahr ist, wird für jede Filterbedingung expr angewendet.

Beispiel für die Metadatenstruktur:

"byText": {
        "PKey": "...",
        "category": "99_none",
        "condition": ...,
        "data": "/profileAndServices/profile/byText?text=$value",
        "formType": "none",
        "fragmentName": "",
        "label": "By name or email",
    }

Verwenden von Filtern

Die Filterung wird mit der folgenden Anfrage durchgeführt:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/by<filterName>?<filterParam>=<filterValue>

Es ist möglich, mehrere Filter in einer einzigen Anfrage zu kombinieren:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/<filter1name>/<filter2name>?<filter1param>=<filter1value>&<filter2param>=<filter2value>

Beispielanfragen

  • Beispielhafte GET-Anfrage zum Abrufen der "Dienst"-Ressourcen mit dem Typ "email".

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Antwort auf die Anfrage.

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-25 23:20:35.000Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/@I_FIiDush4OQPc0mbOVR9USoh36Tt5CsD35lATvQjdWlXrYc0lFkvle2XIwZUbD8GqTVvSp8AfWFUvjkGMe1fPe5nok",
            "label": "Marketing Newsletter",
            "lastModified": "2019-09-25 23:20:35.000Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            ...
        },
        ...
    ],
    ...
}

  • Beispielhafte GET-Anfrage zum Abrufen der "Profil"-Ressourcen, die in den Feldern "E-Mail" oder "Nachname" die Zeichenfolge "Mustermann" enthalten (der byText-Filter sucht sowohl in den Feldern "E-Mail" als auch "Nachname").

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=Doe \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Antwort auf die Anfrage.

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        }
        ...
    ],
    ...
}

  • Beispielhafte GET-Anfrage zum Abrufen der "Dienst"-Ressourcen mit dem Typ "email" und dem Titel "sport".

    code language-none 
    -X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/byText?channel=email&text=sport \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Antwort auf die Anfrage.

    code language-none 
    {
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-26 09:36:01.014Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/<PKEY>",
            "label": "sport",
            "lastModified": "2019-09-26 09:36:01.014Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            "name": "SVC13",
            ...
        }
    ],
    ...
}

Benutzerdefinierte Filter

Wenn Sie einen benutzerdefinierten Filter verwenden möchten, müssen Sie ihn in der Benutzeroberfläche von Adobe Campaign Standard erstellen und anpassen. Der benutzerdefinierte Filter verhält sich dann genauso wie native Filter:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/<resourceName>/by<customFilterName>?<customFilterparam>=<customFilterValue>

Weiterführende Informationen finden Sie in der Campaign Standard-Dokumentation.

Beispielanfrage

Beispielhafte GET-Anfrage zum Abrufen der "Profil"-Ressourcen mit Transaktionsbeträgen von 100 $ oder mehr. Beachten Sie, dass der Filter "byAmount" zunächst in der Benutzeroberfläche von Adobe Campaign Standard definiert und mit der benutzerdefinierten Tabelle "Transaction" verknüpft wurde.

-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byAmount?amount_parameter=100 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
recommendation-more-help
7167b251-0f24-48cd-a4e0-234fe2acbdea