Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In order to assist with the Data Integration (DI) efforts with 3rd party systems (ex: Productsup, Google Shopping, Google Sheet, Google Ads, etc), Boxalino is presenting the Data Feeds services.

Use this service to:

  1. Export your data to other tools in your project (ex: productsup, google shopping feed, etc)

  2. Accessing calculated data in a structured way (per request)

  3. Load files directly to your GCP ecosystem (for order, customers enrichment)

Tip

This is service is currently expanding. We value our clients' feedback.
For further service requests and data feeds, please get in touch with Boxalino.

Table of Contents

GETTING STARTED

For any data required to be exposed (privately), follow the bellow steps:

  1. Get in touch with Boxalino to receive an access key

    1. Communicate the purpose of the data feed & desired information

    2. We will provide an access key

  2. Share the access key with the integration team

  3. The integration team makes an HTTP request to access the data (per documentation bellow)

READ FEED REQUEST

Info

There should be a process within the client project that reads the data from the /read/{access-key} service.

The {access-key} is provided by Boxalino.

As an integrator, please create the bellow request to the provided endpoint.

...

Endpoint

...

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

...

Action

...

/read/{access-key}

...

Method

...

POST

...

Headers

...

In order to assist with the Data Integration (DI) efforts with 3rd party systems (ex: Productsup, Google Shopping, Google Sheet, Google Ads, etc), Boxalino is presenting the Data Feeds services.

Use this service to:

  1. Export your data to other tools in your project (ex: productsup, google shopping feed, etc)

  2. Accessing calculated data in a structured way (per request)

  3. Load files directly to your GCP ecosystem (for order, customers enrichment)

Tip

This is service is currently expanding. We value our clients' feedback.
For further service requests and data feeds, please get in touch with Boxalino.

Table of Contents

GETTING STARTED

For any data required to be exposed (privately), follow the bellow steps:

  1. Get in touch with Boxalino to receive an access key

    1. Communicate the purpose of the data feed & desired information

    2. We will provide an access key

  2. Share the access key with the integration team

  3. The integration team makes an HTTP request to access the data (per documentation bellow)

READ FEED REQUEST

Info

There should be a process within the client project that reads the data from the /read/{access-key} service.

The {access-key} is provided by Boxalino.

As an integrator, please create the bellow request to the provided endpoint.

Endpoint

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

1

Action

/read/{access-key}

2

Method

POST

3

Headers

Authorization

Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

Image Added

*Read more about credentials API Credentials

The data exposed in the data feed is in a JSON format.

The READ service is for authenticated access only.

Tip

The data accessed is from a custom/private SQL script (as defined in the {access-key} configuration), available for the account in the GCS bucket

VIEW FEED REQUEST

Info

There should be a process within client`s own project that accesses the data from the /view/{access-key} service. Final format is CSV file, to be downloaded.

The {access-key} is provided by Boxalino.

As an integrator, please create the bellow request to the provided endpoint.

Endpoint

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

1

Action

/view/{access-key}

2

Method

POST | GET

3

Parameters (optional)

separator

Default: comma (,)

Define a different separator for the .csv file ( tab, pipe (|), etc). One character only!

NOTE: the default will be upgraded to “tab” in order to allow a list of data for value (ex: multivalue fields)

4

format

Default: csv

Change the format of export (ex: txt)

5

page

(optional) pagination; by default - all results are returned;

6

limit

(optional) set a limit for number of rows per request

by default - no limit; when used with page - default limit is 1000.

7

Authorization

only if the key is for authenticated requests
Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

Image Removed
Image Added

*Read more about credentials API Credentials

...

*Currently, the data exposed in the data feed is in a JSON CSV format.

Tip

The

...

Tip

The data accessed is from a custom/private SQL script (as defined in the {access-key} configuration), available for the account in the GCS bucket

...

data accessed is from a custom view in <client>_views dataset (as defined in the {access-key} configuration).

In order to use CSV headers with spaces, the _S_ can be used within SQL select field names.

Note

Parametrized queries are supported (https://cloud.google.com/bigquery/docs/parameterized-queries ). Simply use '@<key>' in the view`s SQL and define the same parameter as _<key>=<value> to the feed URL.

NOTE: all parameter values are casted as STRING.

VIEW GOOGLEADSFEED REQUEST

Info

There should be a process within client`s clients' own project that accesses the data from the /view/googleadsfeed/{access-key} service. Final format is CSV file, to be downloaded.

The {access-key} is provided by Boxalino.

It is only valid for this service.

As an integrator, please create the bellow request to the provided endpoint.

Endpoint

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

1

Action

/view/googleadsfeed/{

access-key}

access-key}?name=<feed-name>

2

Method

POST | GET

3

Parameters (optional)

separator

Default: comma (,)

Define a different separator for the .csv file ( tab, pipe (|), etc). One character only!

NOTE: the default will be upgraded to “tab” in order to allow a list of data for value (ex: multivalue fields)

4

format

Default: csv

Change the format of export (ex

: txt)5

Authorization

only if the key is for authenticated requests
Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

Image Removed*Read more about credentials API Credentials

: txt)

*Currently, the data exposed in the data feed is in a CSV format.

Tip

The data accessed is from a custom view in <client>_views dataset (as defined in the {access-key} configuration)

...

in the data feed is in a CSV format.

The difference between a simple CSV export and a CSV format compatible with Google Ads Uploads is around the Parameters properties before the table header.

The parameters must be defined in the clients` views dataset , in the google_ads_data_feeds_parameters table.

Note

The service will replace every _ from the SQL field names with a space.

JSON FEED REQUEST

As an integrator, please create the bellow request to the provided endpoint.

Info

There should be a process within clients' your own project that accesses requires the data from the /view/googleadsfeedjson/{access-key} service. Final format is CSV file, to be downloaded.Theis JSON.

The {access-key} is provided by Boxalino.

...

It is only valid for this service.

As an integrator, please create the bellow request to the provided endpoint.

...

Endpoint

...

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

...

Action

...

/view/googleadsfeed/{access-key}?name=<feed-name>

...

Method

...

POST | GET

...

Parameters (optional)

...

separator

...

Default: comma (,)

Define a different separator for the .csv file ( tab, pipe (|), etc). One character only!

NOTE: the default will be upgraded to “tab” in order to allow a list of data for value (ex: multivalue fields)

...

format

...

Default: csv

Change the format of export (ex: txt)

*Currently, the data exposed in the data feed is in a CSV format.

...

?name=<feed-name>

2

Method

POST | GET

3

Authorization (header)

only if the key is for authenticated requests
Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

Image Added

*Read more about credentials API Credentials

4

Parameters (optional)

5

page

(optional) pagination; by default - all results are returned;

6

limit

(optional) set a limit for number of rows per request

by default - no limit; when used with page - default limit is 1000.

The data exposed in the data feed is in a JSON format.

The JSON feed rely on the presence of a source in the <client>_views dataset in BigQuery.

Note

Parametrized queries are supported (https://cloud.google.com/bigquery/docs/parameterized-queries ). Simply use '@<key>' in the view`s SQL and define the same parameter as _<key>=<value> to the feed URL.

NOTE: all parameter values are casted as STRING.

GOOGLE SHOPPING FEED REQUEST

As an integrator, please create the bellow request to the provided endpoint.

Info

There should be a process within your own project that requires accesses the data from the /jsongoogleshoppingfeed/{access-key} service.

Final format is JSON.is tab delimited .txt (per Google Shopping Feed requirements). The data is formated based on Google Shopping Feed rules: https://support.google.com/merchants/answer/7052112

The {accessacces-key} is provided by BoxalinoBoxalino.

It is only valid for this service.

Endpoint

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

1

Action

/

json

googleshoppingfeed/{access-key}

?name=<feed-name>

2

Method

POST | GET

3

Authorization (header)

only if the key is for authenticated requests
Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

Image Modified

*Read more about credentials API Credentials

The data exposed in the data feed is in a JSON format.

The JSON feed rely on the presence of a source in the <client>_views dataset in BigQuery.

GOOGLE SHOPPING FEED REQUEST

As an integrator, please create the bellow request to the provided endpoint.

...

There should be a process within your own project that accesses the data from the /googleshoppingfeed/{access-key} service.

...

It is only valid for this service.

...

Endpoint

...

https://boxalino-winning-interactions-krceabfwya-ew.a.run.app

...

Action

...

/googleshoppingfeed/{access-key}

...

Method

...

POST | GET

...

Authorization (header)

...

only if the key is for authenticated requests
Basic base64<<READ API key : READ API Secret>>

note: use the API credentials from your Boxalino account that have the PUBLIC_READ assigned

...

*Read more about credentials API Credentials

...

4

Parameters (optional)

5

page

(optional) pagination; by default - all results are returned;

6

limit

(optional) set a limit for number of rows per request

by default - no limit; when used with page - default limit is 1000.

Tip

The data accessed is from a custom view in <client>_views dataset (as defined in the {access-key} configuration)

In order to use CSV headers with spaces, the _S_ can be used within SQL select field names.

Note

Parametrized queries are supported (https://cloud.google.com/bigquery/docs/parameterized-queries ). Simply use '@<key>' in the view`s SQL and define the same parameter as _<key>=<value> to the feed URL.

NOTE: all parameter values are casted as STRING.

LOAD FEED REQUEST

The LOADFEED service was created in order to load files directly into your project`s BigQuery ecosystem from Boxalino.

...