Cómo utilizar el buzón de feeds genérico

El dropbox de feed genérico permite subir varios tipos de feeds a un solo dropbox por entorno. En esta guía, se explica cómo usar el dropbox genérico y se proporcionan vínculos a la guía adecuada para el feed que planeas usar.

El dropbox genérico depende de que haya dos cargas independientes:

1. Archivo descriptor: Describe el tipo de feed que subirás.
2. Archivos de feed: Es el contenido del feed real.

Estructuración del campo del descriptor

El archivo descriptor se sube para informar a nuestro sistema el tipo de feed que estás subiendo. Esto nos permite validar y procesar el feed correctamente. El archivo descriptor se debe subir antes del contenido del feed y debe cumplir con los siguientes requisitos de nombres:

• Debes usar la extensión de archivo .filesetdesc.json para el archivo del descriptor.
• Cada nombre de archivo del descriptor debe ser único y no se puede volver a usar en las cargas. Te recomendamos que incluyas la marca de tiempo de generación y el nombre del feed en el nombre del archivo.
  • Ejemplo: offers_1524606581.filesetdesc.json
• Cada archivo de descriptor debe incluir todos los archivos de datos del feed más reciente para el nombre de feed relevante.

message FilesetDescriptor {
  // The timestamp at which this feed was generated, in Unix time format
  // (seconds since the epoch). (required)
  int64 generation_timestamp = 1;

  // Identifies the name of this feed. (required)
  string name = 2;

  // Paths (relative to the dropbox root) specifying data files included in this
  // feed. (required)
  repeated string data_file = 3;
}

Entre los valores posibles para el campo name, se incluyen los siguientes:

A continuación, se muestra un ejemplo de archivo descriptor JSON para un feed de ofertas con dos fragmentos:

{
  "generation_timestamp": 1524606581,
  "name": "promote.offer",
  "data_file": [
    "offers_1524606581_1.json",
    "offers_1524606581_2.json"
  ]
}

Estructuración del contenido del feed

Después de subir el archivo de descriptor, subirás todos los archivos del feed para el tipo de datos del feed que corresponde al archivo de configuración del feed que nombró tu archivo de descriptor. Los nombres de archivo y las ubicaciones de ruta de acceso (relativas dentro de Dropbox) deben coincidir exactamente con lo que se incluyó en el campo data_file. Si falta algún archivo, si tiene un nombre incorrecto o si se subió a una ubicación diferente, no se procesará todo el feed.

El contenido de estos archivos de datos del feed debe cumplir con las especificaciones relevantes del feed que se especificaron en el archivo descriptor.

Cada nombre de archivo de feed debe ser único y no se puede volver a usar en las cargas. Te recomendamos que incluyas la marca de tiempo de generación y el número de fragmento (ID incremental) en el nombre del archivo.

• Ejemplo: offers_1524606581_1.json

Tamaños de archivos del feed y frecuencia de carga

• El tamaño del archivo del feed debe ser inferior a 200 MB (después de la compresión).
• El tamaño de cada archivo de datos descomprimido debe ser inferior a 2 GB.
• La mayoría de las integraciones solo necesitarán usar un solo fragmento. Debes usar la menor cantidad posible de fragmentos. Hay un máximo de 1,000 fragmentos por feed.
• No es necesario que los registros individuales que se envían en un Shard se envíen en el mismo número de Shard en feeds futuros.
• Para obtener un mejor rendimiento, divide los datos de manera uniforme entre los Shards a fin de que todos tengan un tamaño similar.
• Si es necesario, usa gzip para comprimir los feeds. Sin embargo, hazlo para cada fragmento de feed individual.

Solución de problemas y depuración

Después de subir tus archivos (descriptor y archivos de feed), ve al panel Historial de feeds (documentación) en el portal de Partners (navega a Historial > Feeds) para seguir el progreso de la transferencia de tu feed.

Busca el name que ingresaste en el archivo descriptor en la columna "Nombre del feed" para encontrar tu feed.

Una vez que se transfiera el feed (el estado es Success o Fail), puedes hacer clic en su fila para ver los detalles de los errores y las advertencias.