Listas estáticas
Criado para:
- Administrador
Referência de Ponto de Extremidade de Listas Estáticas
Referência de Ponto de Extremidade de Associação de Lista
O Marketo oferece um conjunto de APIs REST para executar operações CRUD em listas estáticas. Essas APIs seguem o padrão de interface padrão para APIs de ativos, fornecendo as opções Consultar, Criar, Atualizar e Excluir.
Consultar
A consulta de listas estáticas segue os tipos de consulta padrão para ativos de por id, por nome e procurar.
Por ID
A Consulta por id usa uma única lista estática id como parâmetro de caminho e retorna um único registro de lista estática.
GET /rest/asset/v1/staticList/{id}.json
{
"success": true,
"errors": [],
"requestId": "843c#1641f969e96",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
}
]
}
Por nome
A consulta por nome usa uma lista estática name como parâmetro e retorna um único registro de lista estática. Uma correspondência de sequência exata é executada em relação a todos os nomes de lista estáticos na instância e retorna um resultado para a lista estática correspondente a esse nome.
GET /rest/asset/v1/staticList/byName.json?name=Foundation Seed List
{
"success": true,
"errors": [],
"requestId": "28ab#1641fa246b9",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
}
]
}
Navegar
Listas estáticas também podem ser recuperadas em lotes. O parâmetro folder pode ser usado para especificar a pasta pai na qual a consulta será executada e é formatado como um objeto JSON contendo id e tipo. Assim como outros pontos de extremidade de recuperação de ativos em massa, offset e maxReturn são parâmetros opcionais que podem ser usados para paginação. Os parâmetros earliestUpdatedAt e latestUpdatedAt permitem definir marcas d'água de data e hora baixas e altas para retornar listas estáticas criadas ou atualizadas dentro do intervalo especificado. Os valores de data e hora devem ser strings ISO-8601 válidas e não devem incluir milissegundos
GET /rest/asset/v1/staticLists.json?folder={"id":13,"type":"Folder"}
{
"success": true,
"errors": [],
"requestId": "2dc0#1641f846633",
"result": [
{
"id": 1021,
"name": "Foundation Seed List",
"createdAt": "2017-07-27T01:38:33Z+0000",
"updatedAt": "2017-07-27T01:39:26Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1021A1"
},
{
"id": 1022,
"name": "Blacklist Seed List",
"createdAt": "2017-07-27T23:19:33Z+0000",
"updatedAt": "2017-07-27T23:21:29Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1022A1"
},
{
"id": 1023,
"name": "Possible Duplicates Seed List",
"createdAt": "2017-07-28T00:10:02Z+0000",
"updatedAt": "2017-07-28T00:11:22Z+0000",
"folder": {
"id": 13,
"type": "Folder"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1023A1"
}
]
}
Criar e atualizar
A criação de uma lista estática é executada com um POST application/x-www-form-urlencoded com dois parâmetros obrigatórios. O parâmetro folder é usado para especificar a pasta pai na qual a lista estática será criada e é formatado como um objeto JSON contendo id e tipo. O parâmetro name é usado para nomear a lista estática e deve ser exclusivo. Opcionalmente, o parâmetro description pode ser usado para descrever a lista estática.
POST /rest/asset/v1/staticLists.json
Content-Type: application/x-www-form-urlencoded
folder={"id":1034,"type":"Program"}&name=My Static List
{
"success": true,
"errors": [],
"requestId": "1269d#164209d6e1e",
"result": [
{
"id": 1027,
"name": "My Static List",
"createdAt": "2018-06-21T04:32:25Z+0000",
"updatedAt": "2018-06-21T04:32:25Z+0000",
"folder": {
"id": 1034,
"type": "Program"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1027A1"
}
]
}
As atualizações em uma lista estática são feitas por meio de um ponto de extremidade separado com dois parâmetros opcionais. O parâmetro description pode ser usado para atualizar a descrição da lista estática. O parâmetro name pode ser usado para atualizar o nome da lista estática e deve ser exclusivo.
POST /rest/asset/v1/staticList/{id}.json
Content-Type: application/x-www-form-urlencoded
description=This is a static list used for testing
{
"success": true,
"errors": [],
"requestId": "f84f#16420b4c746",
"result": [
{
"id": 1027,
"name": "My Static List",
"description": "This is a static list used for testing",
"createdAt": "2018-06-21T04:32:26Z+0000",
"updatedAt": "2018-06-21T04:57:55Z+0000",
"folder": {
"id": 1034,
"type": "Program"
},
"computedUrl": "https://app-sjqe.marketo.com/#ST1027A1"
}
]
}
Excluir
A exclusão de uma lista estática usa uma única lista estática id como parâmetro de caminho. As exclusões não podem ser feitas em listas estáticas que estão sendo usadas por uma operação de importação ou exportação ou que estão sendo usadas por outros ativos.
POST /rest/asset/v1/staticList/{id}/delete.json
{
"success": true,
"errors": [],
"requestId": "2c79#16420ded0e9",
"result": [
{
"id": 1027
}
]
}
Associação de Lista
Os endpoints de associação à lista oferecem a capacidade de adicionar, remover e consultar membros da lista estática. Além disso, você pode consultar associação de lista estática.
Adicionar à lista
O ponto de extremidade Adicionar à Lista é usado para adicionar um ou mais membros a uma lista. O ponto de extremidade pega um parâmetro de caminho listId necessário e um ou mais parâmetros de consulta de id que contêm ids de lead (o máximo permitido é 300).
A resposta contém uma matriz result composta de objetos JSON com o status para cada ID de cliente potencial especificada na solicitação.
POST /rest/v1/lists/{listId}/leads.json?id=318594&id=318595
{
"requestId": "6860#1706170ba29",
"result": [
{
"id": 318594,
"status": "added"
},
{
"id": 318595,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
Remover da lista
O ponto de extremidade Remover da Lista é usado para remover um ou mais membros de uma lista. O ponto de extremidade pega um parâmetro de caminho listId necessário e um ou mais parâmetros de consulta id que contêm ids de cliente potencial (o máximo permitido é 300).
A resposta contém uma matriz result composta de objetos JSON com o status para cada ID de cliente potencial especificada na solicitação.
DELETE /rest/v1/lists/{listId}/leads.json?id=318603&id=318595&id=999999
{
"requestId": "9e79#17061689ac3",
"result": [
{
"id": 318603,
"status": "removed"
},
{
"id": 318595,
"status": "removed"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}
Lista de Consultas
O ponto de extremidade Obter Clientes Potenciais por Id de Lista é usado para recuperar membros de uma lista. O ponto de extremidade pega um parâmetro de caminho listId necessário e permite que vários parâmetros de consulta opcionais especifiquem critérios de filtragem.
O parâmetro batchSize é usado para especificar o número de registros de cliente potencial a serem retornados em uma única chamada (o padrão e o máximo são 300).
O parâmetro nextPageToken é usado para paginar por meio de conjuntos de resultados grandes. Esse parâmetro não é transmitido na primeira chamada, mas somente nas chamadas subsequentes da paginação.
O parâmetro fields contém uma lista separada por vírgulas de nomes de campos a serem retornados na resposta. Se o parâmetro fields não estiver incluído nessa solicitação, os seguintes campos padrão serão retornados: email, updatedAt, createdAt, lastName, firstName e id.
A resposta contém uma matriz result composta de objetos JSON contendo os campos de cliente potencial especificados na solicitação.
GET /rest/v1/lists/{listId}/leads.json?batchSize=3
{
"requestId": "ddae#170615ba0cc",
"result": [
{
"id": 318594,
"firstName": "Hanna",
"lastName": "Crawford",
"email": "208161Robert.L.Deacon@pookmail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318595,
"firstName": "Bertha",
"lastName": "Fulton",
"email": "208160Tyrone.V.Dyer@trashymail.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
},
{
"id": 318596,
"firstName": "Faith",
"lastName": "England",
"email": "208159Rex.M.Bailey@dodgit.com",
"updatedAt": "2015-04-06T17:13:50Z",
"createdAt": "2015-04-06T17:13:50Z"
}
],
"success": true,
"nextPageToken": "PS5VL5WD4UOWGOUCJR6VY7JQO24LC2U5DRBU4WO4RQMPHDHTK2T3BEZOR75VLQXYB3245WW2GMDSK==="
}
Associação à Lista de Consultas por ID de Cliente Potencial
O ponto de extremidade Membro da Lista é usado para ver se um ou mais clientes em potencial são membros de uma lista. O ponto de extremidade pega um parâmetro de caminho listId necessário e um ou mais parâmetros de consulta id que contêm ids de cliente potencial (o máximo permitido é 300).
A resposta contém uma matriz result composta de objetos JSON com o status para cada ID de cliente potencial especificada na solicitação.
GET /rest/v1/lists/{listId}/leads/ismember.json?id=309901&id=318603&id=999999
{
"requestId": "693a#17061475cf9",
"result": [
{
"id": 309901,
"status": "memberof"
},
{
"id": 318603,
"status": "notmemberof"
},
{
"id": 999999,
"status": "skipped",
"reasons": [
{
"code": "1004",
"message": "Lead not found"
}
]
}
],
"success": true
}