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.

...

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 Added

*Read more about credentials API Credentials

*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 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

...

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.

...

Endpoint

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

1

Action

/json/{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 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

...

Info

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

Final format 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 {acces-key} is provided by Boxalino.

It is only valid for this service.

Endpoint

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

1

Action

/googleshoppingfeed/{access-key}

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.

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.

...

Code Block
SELECT
'<FEED NAME>' as name
, '<FEED SOURCE: direct|aws>' AS source
, '<ACCESS CONFIGURATION/HEADERS AS JSON>' AS access
, '<LINK OR PATH TO FILES TO BE DOWNLOADED>' AS url
, '' AS body
, ';' AS field_delimiter
, '<CONTENT FORMAT: CSV,NEWLINE_DELIMITED_JSON>' AS format
, '<BOXALINO ACCOUNT NAME>_core' AS destination_dataset
, '<TABLE NAME>' AS destination_table
, true AS autodetect
, '<SCHEMA (string or JSON) IF autodetect=false>' AS schema
, 0 AS add_body_as_record
, 0 AS add_tm_to_record
, 1 AS skipRows
, 0 AS max_bad_records
, '' AS quote
, 'WRITE_TRUNCATE | WRITE_APPEND' AS write_disposition
, '' AS create_disposition
, '' AS encoding
, '<CRONJOB CONFIGURATION FOR LOADING FILES, EX: 20 12 * * *>' AS cronjob
, 'feed' AS type

...