Elenchi di account denominati

Riferimento endpoint elenchi account denominati

Elenchi account denominati in Marketo rappresentano insiemi di account denominati. Possono essere utilizzati per un’ampia varietà di casi, tra cui categorizzazione, arricchimento dei dati e filtro intelligente delle campagne. Le API dell’elenco di account denominati consentono la gestione remota di queste risorse dell’elenco e della loro appartenenza.
Content

Autorizzazioni

Per eseguire una query sugli elenchi di account denominati, è necessario disporre dell'autorizzazione Elenco account denominati di sola lettura o Elenco account denominati di lettura/scrittura. Per creare, aggiornare o eliminare elenchi, è necessaria l'autorizzazione Lettura/scrittura elenco account denominati. La query dell'appartenenza a un elenco richiede le autorizzazioni Account denominato di sola lettura o Account denominato di lettura-scrittura, mentre la gestione dell'appartenenza richiede le autorizzazioni Account denominato di lettura-scrittura.

Modello

Gli elenchi account denominati dispongono di un numero limitato di campi standard e non sono estensibili con i campi personalizzati.
Named Account List Field

Query

La query degli elenchi di account è semplice. Attualmente, esistono solo due filterTypes validi per eseguire query sugli elenchi di account denominati: "dedupeFields" e "idField". Il campo su cui filtrare è impostato nel parametro filterType della query e i valori sono impostati in filterValues as un elenco separato da virgole. I filtri nextPageToken e batchSize sono anche parametri facoltativi.

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

Crea e aggiorna

La creazione e l'aggiornamento dei record dell'elenco dei conti denominati seguono i modelli stabiliti per altre operazioni di creazione e aggiornamento del database lead. Tenere presente che gli elenchi di account denominati hanno un solo campo aggiornabile, name.

L’endpoint consente due tipi di azione standard: "createOnly" e "updateOnly".  action defaults a "createOnly".

È possibile specificare dedupeBy parameter facoltativo se l'azione è updateOnly.  I valori consentiti sono "dedupeFields" (corrispondente a "name") o "idField" (corrispondente a "marketoGUID").  In modalità createOnly, solo "name" è consentito come campo dedupeBy. È possibile inviare fino a 300 record alla volta.

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"
      }
   ]
}

Elimina

L'eliminazione degli elenchi di account denominati è semplice e può essere eseguita in base a name o marketoGUID dell'elenco. Per selezionare la chiave da utilizzare, passare "dedupeFields" per il nome o "idField" per marketoGUID nel membro deleteB della richiesta. Se non viene impostato, per impostazione predefinita verranno utilizzati dedupeFields. È possibile eliminare fino a 300 record alla volta.

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"
            }
         ]
      }
   ]
}

Nel caso in cui non sia possibile trovare un record per una determinata chiave, l'elemento risultato corrispondente avrà un status di "ignorato" e un motivo con un codice e un messaggio che descrivono l'errore, come mostrato nell'esempio precedente.

Gestione dell’iscrizione

Iscrizione alla query

La query dell'appartenenza a un elenco di account con nome è semplice e richiede solo i dell'elenco di account. I parametri facoltativi sono:

-field - elenco di campi separati da virgole da includere nei record di risposta
-nextPageToke - per il paging attraverso il set di risultati
-batchSiz - per specificare il numero di record da restituire

Se field non è impostato, verranno restituiti marketoGUI, nam, createdA e updatedA. batchSiz ha un valore massimo e predefinito di 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"
      }
   ]
}

Aggiungi membri

Gli account denominati possono essere facilmente aggiunti a un elenco di account denominati. Gli account possono essere aggiunti solo utilizzando il relativo marketoGUID. È possibile aggiungere fino a 300 record alla volta.

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

Rimuovi membri

La rimozione di record da un elenco account ha un percorso diverso, ma la stessa interfaccia richiede marketoGUI per ogni record che si desidera eliminare. È possibile rimuovere fino a 300 record alla volta.

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
}

Timeout