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

A caixa de depósito de feed genérico permite que vários tipos de feed sejam enviados para uma única caixa de depósito por ambiente. Este guia mostra como usar a caixa de depósito genérica e fornece links para o guia apropriado do respectivo feed que você planeja usar.

A caixa de depósito genérica depende da existência de dois uploads separados:

  1. Arquivo descritor: descreve o tipo de feed que será enviado
  2. Arquivos de feed: o conteúdo do feed real

Como estruturar o campo do descritor

O arquivo descritor é enviado 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 descritor precisa ser único e não pode ser reutilizado em todos os uploads. Recomendamos incluir o carimbo de data/hora de geração no nome do arquivo.
    • Exemplo: offer_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:

  • reservewithgoogle.conversion_data

Um exemplo de arquivo descritor JSON para um feed de ofertas com dois fragmentos está disponível abaixo:

{
  "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 enviar o arquivo descritor, você enviará todos os arquivos de feed para o tipo de dados de feed correspondente ao arquivo de configuração de feed nomeado pelo seu arquivo descritor. Os nomes dos arquivos e os locais dos caminhos (relativos na caixa de depósito) precisam corresponder exatamente ao que foi incluído no campo data_file. Se um 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 arquivo de feed precisa ser exclusivo e não pode ser reutilizado em todos os uploads. Recomendamos incluir o carimbo de data/hora de geração e o número do fragmento (ID incremental) no nome de arquivo.

  • Exemplo: offer_1524606581_1.json

Tamanhos dos arquivos do feed e frequência de upload

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

Solução de problemas e depuração

Depois de fazer o upload dos arquivos (descritores e arquivos de feed), acesse o painel Histórico de feeds (documentação) no Portal do parceiro (navegue até Histórico > Feeds) para acompanhar o progresso da ingestão do feed.

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

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