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 respectivo feed que planeas usar.

Consulta la sección Exporta feeds (de extremo a extremo) o Feeds (inicio) de la documentación.

La dropbox genérica se basa en dos cargas separadas:

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

Estructura el campo del descriptor

El archivo descriptor se carga para informar a nuestro sistema sobre el tipo de feed que subes. Esto nos permite validar y procesar el feed correctamente. El archivo descriptor debe subirse antes del contenido del feed y debe seguir estos requisitos de nombres:

  • Cómo usar la extensión de archivo .filesetdesc.json
  • Cada nombre de archivo descriptor debe ser único y no se puede volver a utilizar en todas las cargas. Recomendamos incluir la marca de tiempo de generación en el nombre del archivo.
    • Ejemplo: offers_1524606581.filesetdesc.json
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 incluye un archivo descriptor JSON de ejemplo para un feed de ofertas con dos fragmentos:

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

Estructura el contenido del feed

Después de subir el archivo descriptor, subirás todos los archivos de feed para el tipo de datos de feed correspondiente al archivo de configuración de feed con el nombre de tu archivo descriptor. Los nombres de archivo y las ubicaciones de ruta (relativas dentro del dropbox) deben coincidir exactamente con lo que se incluyó en el campo data_file. Si algún archivo falta, tiene un nombre incorrecto o 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 pertinentes del feed que se especificó en el archivo descriptor.

Cada nombre de archivo del feed debe ser único y no se puede volver a utilizar en todas las cargas. Recomendamos incluir la marca de tiempo de la generación y el número del 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 los 200 MB (después de la compresión).
  • La mayoría de las integraciones solo necesitarán un fragmento. Deberías usar la menor cantidad de fragmentos posible. Hay un máximo de 1,000 Shards por feed.
  • No es necesario que los registros individuales enviados en un Shard se envíen en el mismo número de Shard en los 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, use gzip para comprimir los feeds. Sin embargo, debes hacerlo para cada fragmento de feed individual.

Solución de problemas y depuración

Después de subir los archivos (descriptores y de feed), ve al Panel de historial del feed (documentación) del portal de socios (navega hasta Historial > Feeds) para seguir el progreso de la transferencia del feed.

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

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