DOCUMENTACIÓN
- Para comenzar con la Plataforma Magenta Advertising
- Requisitos de cumplimiento para la recopilación de datos del editor
CONSOLA
API DE MARKETPLACE DE DATOS
TRASFERENCIA E INTEGRACIÓN DE DATOS
Importar
El endpoint Importar te permite indicar a la plataforma Magenta Advertising que importe un archivo con identificadores de publicidad y los atributos asociados desde S3. Cuando la Plataforma Publicitaria Magenta te aprovisione, recibirás un conjunto de credenciales de S3 en Amazon Web Services y un prefijo de bucket/ruta. A continuación, crearás los archivos de datos que se importarán, cargarás cada archivo en Amazon S3 y, luego, publicarás en el endpoint de importación de API para indicar a Magenta Advertising Platform que ponga en cola el trabajo de importación. También puedes solicitar registros de importación a través de la API para comprobar el estado de cada archivo que pongas en cola para importar.
La plataforma Magenta Advertising también admite la incorporación desde su propio bucket de S3. Al ejecutar el endpoint «/v1/marketplace/import», puedes proporcionar opcionalmente un bucket y las credenciales que se utilizarán para la importación. En caso contrario, Magenta Advertising Platform intentará realizar la incorporación desde el bucket y la ruta que te asignamos durante la configuración del socio.
Una importación es una sustitución completa de todos los atributos presentes en la plataforma. Una importación no es una adición, es una eliminación seguida de una inserción. Cada vez que realices una importación tendrás que enviar una lista completa de todos los identificadores asociados a cada atributo. Esto no significa que todos los datos deban estar en un único archivo. En realidad, es mejor que los datos estén divididos en varios archivos, ya que nos permite procesarlos con mayor rapidez. No realices una petición a la API de importación para cada archivo; en cambio, sube todos los archivos a un prefijo/directorio común y especifica el prefijo como parte de la petición a la API de importación. Cargaremos todos los archivos con el mismo prefijo en paralelo.
Las importaciones se ponen en cola y se completarán en el orden en que se envíen.
Destino
Listar registros de importación
Muestra las últimas 100 tareas de importación en orden inverso a su creación.
cURL
curl -X GET -H "Authorization: Bearer <APIKEY>" "https://api.magentamarketing.com/v1/marketplace/import"
Response
JSON
[
{
"import_log_id":3,
"file_path":"export1.csv",
"path_type": 0,
"key_type": 0,
"status":0,
"log_type": 0,
"keys":null,
"unique_devices":"1234",
"total_rows":"1300",
"errors":null,
"created_at":"2016-09-16T15:49:01.437Z",
"updated_at":"2016-09-16T15:49:01.437Z"
},
{
"import_log_id":4,
"file_path":"export2.csv",
"path_type": 0,
"key_type": 1,
"status":0,
"log_type": 0,
"keys":null,
"unique_devices":"4321",
"total_rows":"5000",
"errors":null,
"created_at":"2016-09-1T5:49:01.437Z",
"updated_at":"2016-09-1T5:49:01.437Z"
}
]
| Estado | Significado |
| 0 | Pendiente. Todas las solicitudes se manejan por orden de recepción. Si tu proceso de importación muestra este código de status, está en espera detrás de otros procesos de importación. |
| 1 | Importando. |
| 2 | Listo |
| 3 | Error. Ha ocurrido algo durante la importación |
Obtener registro de importación
Obtiene una única entrada del registro de importación
cURL
curl -X GET -H "Authorization: Bearer <APIKEY>" "https://api.magentamarketing.com/v1/marketplace/import/3"
Response
JSON
[
{
"import_log_id":3,
"file_path":"export1.csv",
"path_type": 0,
"key_type": 1,
"status":0,
"log_type": 0,
"keys":null,
"unique_devices":"1234",
"total_rows":"1300",
"errors":null,
"created_at":"2016-09-16T15:49:01.437Z",
"updated_at":"2016-09-16T15:49:01.437Z"
}
]
Importar
Pone en cola un archivo para su importación.
Parámetros
| Field (Campo) | Obligatorio | Tipo | Descripción |
| file_path | Y | cadena | Una ruta de archivo relativa. No incluyas s3://import-pushspring-com o tu prefijo de ruta asignado. Si cargaste un archivo en s3://import-pushspring-com//export.csv la ruta relativa sería «export.csv». If you specify a path_type of 1 below this should be a absolute path of the form s3:///. También puede representar un prefijo de ruta. Si se utiliza un prefijo de ruta, se cargarán todos los archivos que se encuentren bajo ese prefijo. Si necesitas cargar varios archivos al día, este método es más recomendable que las peticiones de importación individuales. |
| key_type | Y | Número entero | Indica los tipos de claves del archivo que se importa. 0 = MAP assigned attribute_id 1 = partner_foreign_key associated with attribute Make sure the partner_foreign_key is associated with an attribute before importing the file. |
| path_type | N | ||
| compressed |
N | boolean | If not specified and path_type includes a single file we will look at the file extension and if it is ".gz" we will assume the file is compressed. If you are using a path prefix for the file_path you must specify this as there is no file extension to look at to determine if the file is compressed. El valor predeterminado es Falso. |
| credenciales | N | objeto | Para un bucket de S3 propiedad de un socio, las credenciales deben incluir: { "accessKeyId": "XXXXX", "secretAccessKey":"YYYY", "region":"ZZZZZ" } La región debe ser la región de AWS en la que se encuentra el bucket, por ejemplo, "us-west-2". |
file_path can be either a file i.e. export.csv OR a path prefix like 2020/09/15/. Si se trata de un prefijo de ruta, cargaremos todos los archivos en paralelo.
Muestra
cURL
curl -X POST -H "Authorization: Bearer <APIKEY>" -H "Content-Type: application/json"
-d '{
"file_path":"export.csv",
"key_type":0
}' "https://api.magentamarketing.com/v1/marketplace/import"
Response
JSON
{
"import_log_id":4
}
Borrar
Ocasionalmente puede ser necesario eliminar los datos asociados a un atributo. NOTA: Estos datos se borran permanentemente y no se pueden restaurar.
| Field (Campo) | Obligatorio | Descripción | |
| key_type | Y | Indica los tipos de claves del archivo que se importa. 0 = MAP assigned attribute_id 1 = partner_foreign_key associated with attribute Make sure the partner_foreign_key is associated with an attribute before importing the file. |
|
| teclas | Y | Either the attribute_ids or partner_foreign_keys you wish to delete. |
Muestra
cURL
curl -X POST -H "Authorization: Bearer <APIKEY>" -H "Content-Type: application/json"
-d '{
"file_path":"export.csv",
"key_type":0
}' "https://api.magentamarketing.com/v1/marketplace/import"
Response
JSON
{
"import_log_id":4
}