Namenskontenlisten

Endpunktverweis für benannte Kontolisten

Namensgebene Kontolisten in Marketo stellen Sammlungen benannter Konten dar. Sie können für eine Vielzahl von Fällen verwendet werden, einschließlich Kategorisierung, Anreicherung von Daten und Filterung intelligenter Kampagnen. Die APIs für die Liste benannter Konten ermöglichen die Remote-Verwaltung dieser Listen-Assets und ihrer Mitgliedschaft.
Content

Berechtigungen

Zum Abfragen von Listen mit benannten Konten ist die Berechtigung Schreibgeschützte Kontoliste oder Lese-Schreib-Liste mit benannten Konten erforderlich. Zum Erstellen, Aktualisieren oder Löschen von Listen ist die Berechtigung "Benannte Kontoliste lesen"erforderlich. Für die Abfrage der Listenzugehörigkeit sind die Berechtigungen "Schreibgeschütztes Konto"oder "Benanntes Konto lesen/schreiben"erforderlich. Für die Verwaltung der Mitgliedschaft sind die Berechtigungen "Benanntes Konto lesen und schreiben"erforderlich.

Modell

Namenslisten verfügen über eine begrenzte Anzahl von Standardfeldern und sind nicht durch benutzerdefinierte Felder erweiterbar.
Named Account List Field

Anfrage

Die Abfrage von Kontolisten ist einfach und einfach. Derzeit gibt es nur zwei gültige filterTypes für die Abfrage von benannten Kontolisten: "dedupeFields"und "idField". Das Feld, nach dem gefiltert werden soll, wird im Parameter filterType der Abfrage festgelegt und die Werte werden in filterValues as in einer kommagetrennten Liste festgelegt. Die Filter nextPageToken und batchSize sind ebenfalls optionale Parameter.

GET /rest/v1/namedAccountLists.json?filterType=idField&filterValues=dff23271-f996-47d7-984f-f2676861b5fb,dff23271-f996-47d7-984f-f2676861b5fc

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "name": "Saas List",
         "createdAt": "xxxxxxxx",
         "updatedAt": "xxxxxxxx",
         "type": "default",
         "updateable": true
      },
      {
         "seq": 1,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc",
         "name": "My Account List",
         "createdAt": "xxxxxxxx",
         "updatedAt": "xxxxxxxx",
         "type": "default",
         "updateable": true
      }
   ]
}

Erstellen und Aktualisieren

Das Erstellen und Aktualisieren von benannten Kontolistendatensätzen folgt den festgelegten Mustern für andere Vorgänge zum Erstellen und Aktualisieren von Lead-Datenbanken. Beachten Sie, dass benannte Kontolisten nur ein aktualisierbares Feld, name, aufweisen.

Der Endpunkt ermöglicht die beiden standardmäßigen Aktionstypen "createOnly"und "updateOnly".  Der action defaults-Wert "createOnly".

Das optionale dedupeBy parameter kann angegeben werden, wenn die Aktion updateOnly ist.  Zulässige Werte sind "dedupeFields"(entspricht "name") oder "idField"(entspricht "marketoGUID").  In den Modi createOnly ist nur "name"als Feld dedupeBy zulässig. Sie können bis zu 300 Datensätze gleichzeitig versenden.

POST /rest/v1/namedAccountLists.json

{
   "action": "createOnly",
   "dedupeBy": "dedupeFields",
   "input": [
      {
         "name": "SAAS List"
      },
      {
         "name": "Manufacturing (Domestic)"
      }
   ]
}

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "status": "created",
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
      },
      {
         "seq": 1,
         "status": "created",
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc"
      }
   ]
}

Löschen

Das Löschen von Listen mit benannten Konten ist einfach und kann entweder auf der Basis von name oder der marketoGUID der Liste erfolgen. Um den Schlüssel auszuwählen, den Sie verwenden möchten, übergeben Sie entweder "dedupeFields"für name oder "idField"für marketoGUID im deleteB-Mitglied Ihrer Anfrage. Wenn diese Option deaktiviert ist, wird standardmäßig dedupeFields verwendet. Sie können bis zu 300 Datensätze gleichzeitig löschen.

POST /rest/v1/namedAccountLists/delete.json

{
   "deleteBy": "dedupeFields",
   "input": [
      {
         "name": "Saas List"
      },
      {
         "name": "B2C List"
      },
      {
         "name": "Launchpoint Partner List"
      }
   ]
}

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "status": "deleted"
      },
      {
         "seq": 1,
         "id": "dff23271-f996-47d7-984f-f2676861b5fc",
         "status": "deleted"
      },
      {
         "seq": 2,
         "status": "skipped",
         "reasons": [
            {
               "code": "1013",
               "message": "Record not found"
            }
         ]
      }
   ]
}

Falls ein Datensatz für einen bestimmten Schlüssel nicht gefunden werden kann, hat das entsprechende Ergebniselement den Wert status "skipped"(übersprungen) und einen Grund mit einem Code und einer Meldung, die den Fehler beschreibt, wie im obigen Beispiel gezeigt.

Verwalten der Mitgliedschaft

Mitgliedschaft in Abfragen

Die Abfrage der Mitgliedschaft in einer Liste mit benannten Konten ist einfach und erfordert nur den i der Kontoliste. Optionale Parameter sind:

-field - eine kommagetrennte Liste von Feldern, die in die Antwortdatensätze aufgenommen werden sollen
-nextPageToke - für das Paging durch den Ergebnissatz
-batchSiz - zur Angabe der Anzahl der zurückzugebenden Datensätze

Wenn field nicht festgelegt ist, werden marketoGUI, nam, createdA und updatedA zurückgegeben. batchSiz hat einen Maximalwert und einen Standardwert von 300.

GET /rest/v1/namedAccountList/{id}/namedAccounts.json

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "name": "Saas List",
         "createdAt": "2017-02-01T00:00:00Z",
         "updatedAt": "2017-03-05T17:21:15Z"
      },
      {
         "seq": 1,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc",
         "name": "My Account List",
         "createdAt": "2017-02-01T00:00:00Z",
         "updatedAt": "2017-03-05T17:21:15Z"
      }
   ]
}

Mitglieder hinzufügen

Named-Konten können einfach zu einer Liste mit benannten Konten hinzugefügt werden. Konten dürfen nur mit ihrer marketoGUID hinzugefügt werden. Sie können bis zu 300 Datensätze gleichzeitig hinzufügen.

POST /rest/v1/namedAccountList/{id}/namedAccounts.json

{
    "input": [
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        },
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        }
    ]
}

{
    "requestId": "string",
    "result": [
        {
            "seq": 0,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        },
        {
            "seq": 1,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        }
    ],
    "success": true,
}

Mitglieder löschen

Das Entfernen von Datensätzen aus einer Kontoliste hat einen anderen Pfad, aber dieselbe Benutzeroberfläche, die einen marketoGUI für jeden Datensatz erfordert, den Sie löschen möchten. Sie können bis zu 300 Datensätze gleichzeitig entfernen.

POST /rest/v1/namedAccountList/{id}/namedAccounts/remove.json

{
    "input": [
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        },
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        }
    ]
}

{
    "requestId": "string",
    "result": [
        {
            "seq": 0,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        },
        {
            "seq": 1,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        }
    ],
    "success": true
}

Timeouts