Syncing Data

Introduction

In order to generate Ads, CitrusAd needs product, customer, and order data from retailers. The data needs to be populated by the retailer, then it is stored, processed, and updated in the system of CitrusAd. To automate the process of downloading and updating the data, both CitrusAd and each retailer need to agree on the format and structure of the data, as well as the protocol for the communication between the retailer's and CitrusAd systems. This documentation describes in detail the specifications for the constraints on the feeding of three types of data: product, customer, and order data.

Syncing Options

Depending on your integration requirements you may wish to sync your data via API, or by syncing files. CitrusAd supports both types of syncing, please see the respective pages for each type of data.

Sync Data Via File Or API?

The decision on how to sync data is ultimately up to the integrator, both options have their benefits and drawbacks. Larger integrators prefer to sync via file as it aligns more with resource capabilities and only requires files to be uploaded at their preferred scheduling.

CitrusAd recommend syncing data via file. It is easier to troubleshoot and resolve issues. In the event of integrator file issues, previous catalog files can be reinstated until fixed.

Syncing data via API:

Pros:

  • Faster data ingestions and updates

  • Self sufficient

Cons:

  • Data must be batched

  • Higher difficulty in troubleshooting

  • Cannot rollback to previous updates

Syncing data via File:

Pros:

  • Single file supported per data type supported as opposed to batching

  • Can be synced at preferred timing intervals (Daily recommended)

  • Different protocol support (FTP, FTPS, SFTP, SCP, HTTP, HTTPS, and AWS S3)

  • Easier when troubleshooting

  • Can rollback to previous files

Cons:

  • Data is updated once ingested

  • Higher difficulty in support troubleshooting

Syncing Data Via File Protocols

There are additional protocols and practices that need to be adhered to when syncing data via file.

Please see "Syncing Data Via File Protocols" for more information