Overview

This node is capable of publishing the pipeline metadata periodically in a Google Spreadsheet or when a trigger condition is met.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Description	Type	Default	Required
`trigger_type`	When to collect metadata. Options: - `custom_trigger`: Custom trigger - `auto_trigger`: When significant node properties change - `periodic`: At an interval - `scheduled`: At fixed times past the hour	enum	`auto_trigger`	Yes
`trigger`	Publish when this condition evaluates to true. Only used when `trigger_type` is `custom_trigger`. Expression must evaluate to true/false. The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to `True` or `False`. See details here. ex. `nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0`	trigger-condition	null	No
`interval`	How frequently to publish metadata in seconds. Set to 0 to publish every time metadata is collected.	number	5	Yes
`schedule_publishing`	Schedule publishing at fixed times. Only used when `trigger_type` is `scheduled`. Options: - `null`: Disabled - `day`: Daily - `hour`: Hourly - `30min`: Every 30 minutes - `15min`: Every 15 minutes	enum	null	No
`meta_to_publish_type`	Type of metadata to publish. Options: - `node_meta`: Node metadata - `object_meta`: Object metadata - `custom`: Define the metadata via a path expression (see below)	enum	`custom`	Yes
`meta_to_publish_regex`	Comma-separated regular expressions to select metadata to publish. Only used when `meta_to_publish_type` is `custom`.	metadata-list	`nodes.._delta,nodes...._delta`	No
`objects_to_publish`	Object types to publish (comma separated). Only used when `meta_to_publish_type` is `object_meta`. ex. `car, vehicle, truck`	model-label	null	No
`objects_only_new_updated`	If true, only publish objects when first seen. If false, publish both new and updated objects	bool	true	No
`use_lumeo_gsheets_account`	Use Lumeo-managed Google account to publish to Sheets. If enabled, share your Google sheet with `[email protected]`	bool	false	No
`gsheets_client_email`	Email address to use for Google Sheets API requests. Only used when `use_lumeo_gsheets_account` is false. ex. `[email protected]`	string	null	No
`gsheets_private_key`	Private key for Google Sheets API authentication. Only used when `use_lumeo_gsheets_account` is false. ex. `-----BEGIN PRIVATE KEY----- (...)`	text	null	No
`gsheets_spreadsheet_id`	ID of the Google Sheet to publish to. ex. `1dTxg-PUPPg4hRJkULek-RgzmVd47RfdH-SGBGuC7iqS`	string	null	No
`gsheets_sheet_name`	Name of the tab/sheet within the Google Sheet to publish to	string	`Sheet1`	No

Google Sheets API registration

To use the Google Sheets API service with your own API account, you need to get OAuth 2.0 credentials from the Google API Console.

Using your Google account, visit the Google API Console website.

Click On Library and search for Google Sheets API
Press Enable button (Fig 1)

You should be redirected to the Google Sheets API Service page.
On the Credentials menu press Create Credentials -> Service account (Fig 2)

On the "Create service account page" you need to introduce the name you want to use for the Service account, the Service account email address, and a short description.
Press Done when finished (Fig 3)

On the next window you can grant the service account access to your project resources (Fig 4)

After the service account is created, you need to open the Keys separator.
Now click on Add Key -> Create new key (Fig 5)

Chose JSON Key type and press Create. (Fig 6)
This should start the download of a JSON file containing your service account credentials.

Open the JSON file with a text editor. (Fig 7)
Here you can find on each line a set of key/value pairs.
The client_email and the private_key are required for the node configuration.
You should use their values (without enclosing quotes) to fill respectively the following fields of the node properties: Google Sheets Client Email and Google Sheets Private Key

On the Google Drive, create a new Spreadsheet. Right-click on the file and press Share
Add the client_email of your service account as Editor. (Fig 8)

To find the Spreadsheet ID, open the spreadsheet file on Google Drive.

You will see an URL like this: https://docs.google.com/spreadsheets/d/10Rx6088O56gDDPpy0FYB9FDZ30Dzj13P-4b5wXwzXTD/edit#gid=0

The 10Rx6088O56gDDPpy0FYB9FDZ30Dzj13P-4b5wXwzXTD part is the spreadsheet ID that should be introduced on the node property Google Spreadsheet ID

To fill the Google Sheet Name node property, check the name on the bottom left corner, in this case Sheet1 (Fig 9)

Metadata to Publish

In this field you can insert multiple path expressions, separated by comma, to include or exclude the metadata that should be published by the node.

Example:
When parsing metadata augmented by the Line Counter Node we can select the total objects that crossed both directions of the lines specified on the Line Counter Node using the following regular expression:
nodes.annotate_line_counter1.lines.*.dir*.*crossed*

Fields appended on-the-fly to metadata published on the Google Sheets

Key	Value
`system_timestamp`	Current system timestamp ex. `2021-04-14 09:22:24.617855`
`frame_timestamp`	Timestamp computed based on frames difference, since the start of the pipeline execution ex. `'0:04:00`

Metadata

This node does not add any new metadata to the frame.

Metadata Property	Description
None	None