Como usar a caixa de depósito de feed genérico

Com a caixa de depósito genérica, é possível fazer o upload de vários tipos de feed em uma única caixa de depósito por ambiente. Este guia explica como usar a caixa de depósito genérica e fornecerá links para o guia apropriado do respectivo feed.

Consulte as seções Exportar feeds (de ponta a ponta) ou Feeds (iniciante) da documentação.

A caixa de depósito genérica depende de que haja dois uploads separados:

  1. Arquivo descritor: descreve o tipo de feed que você enviará.
  2. Arquivos do feed: o conteúdo do feed real.

Como estruturar o campo descritor

O upload do arquivo descritor é feito para informar ao nosso sistema o tipo de feed que você está enviando. Isso nos permite validar e processar o feed corretamente. O arquivo descritor precisa ser enviado antes do conteúdo do feed e precisa seguir estes requisitos de nomenclatura:

  • Usar a extensão de arquivo .filesetdesc.json
  • Cada nome de arquivo do descritor precisa ser exclusivo e não pode ser reutilizado em uploads. Recomendamos incluir o carimbo de data/hora de geração no nome do arquivo.
    • Exemplo: 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;
}

Os valores possíveis para o campo name incluem:

Veja abaixo um exemplo de arquivo descritor do JSON para um feed de ofertas com dois fragmentos:

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

Como estruturar o conteúdo do feed

Depois de fazer upload do arquivo descritor, faça upload de todos os arquivos de feed para o tipo de dados de feed correspondente ao arquivo de configuração de feed nomeado pelo arquivo descritor. Os nomes dos arquivos e os locais dos caminhos (relativos à caixa de depósito) precisam corresponder exatamente aos incluídos no campo data_file. Se algum arquivo estiver ausente, nomeado incorretamente ou enviado para um local diferente, todo o feed não será processado.

O conteúdo desses arquivos de dados de feed precisa estar em conformidade com a especificação relevante do feed que foi especificada no arquivo descritor.

Cada nome de arquivo de feed precisa ser único e não pode ser reutilizado em uploads. Recomendamos incluir o carimbo de data/hora de geração e o número do fragmento (ID incremental) no nome de arquivo.

  • Exemplo: Offers_1524606581_1.json

Tamanhos de arquivo do feed e frequência de upload

  • O arquivo precisa ter até 200 MB (após a compactação).
  • A maioria das integrações só vai precisar usar um único fragmento. Use o mínimo possível de fragmentos. Há um máximo de 1.000 fragmentos por feed.
  • Registros individuais enviados em um fragmento não precisam ser enviados no mesmo número de fragmento em feeds futuros.
  • Para melhorar o desempenho, divida os dados uniformemente entre os fragmentos para tornar todos os arquivos de fragmento semelhantes em tamanho.
  • Se necessário, use gzip para compactar feeds. No entanto, faça isso para cada fragmento de feed individual.

Solução de problemas e depuração

Depois de fazer upload dos seus arquivos (arquivos de descritor e de feed), acesse o painel do Histórico de feeds (documentação) no Portal do parceiro (acesse Histórico > Feeds) para acompanhar o andamento da ingestão do seu feed.

Procure o name que você tem no arquivo descritor na coluna "Nome do feed" para encontrar seu feed.

Depois que o feed for ingerido (o status é Success ou Fail), clique na linha dele para ver os detalhes dos erros e avisos.