Google Data Studio Search

Google Data Studio Search

Certified

Search Data Studio assets

Search reports and data sources the authenticated Workspace user can access. The API accepts one asset type per call; this task queries each type you list and merges the pages. The task fails when a query exceeds maxPages instead of returning a partial list. STORE writes each page to the Ion file as it arrives.

yaml
type: io.kestra.plugin.datastudio.assets.Search

List all reports owned by a user

yaml
id: assets_search
namespace: company.team

inputs:
  - id: owner_email
    type: STRING
    defaults: owner@acme.com

tasks:
  - id: search
    type: io.kestra.plugin.datastudio.assets.Search
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_JSON') }}"
    assetTypes:
      - REPORT
    owner: "{{ inputs.owner_email }}"
Properties
SubTypestring
Possible Values
REPORTDATA_SOURCEUNKNOWN

Asset types

Asset types to search. Each value is queried separately because the API accepts exactly one type per request. Allowed values are REPORT and DATA_SOURCE. UNKNOWN is output-only and is rejected here.

Access token

OAuth access token. When set, the service account exchange is skipped, so the token must already include datastudio.readonly for read tasks or datastudio for Add and Revoke.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://datastudio.googleapis.com/v1

API base URL

Data Studio API root. Defaults to https://datastudio.googleapis.com/v1.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Fetch type

STORE writes an Ion file and is the right choice for an organisation-wide inventory. FETCH returns every asset in the execution context and is meant for a small result set. FETCH_ONE returns the first asset from the first page that has one. NONE returns only the count.

Defaultfalse

Include trashed assets

When true, only trashed assets are returned. When false, only assets that are not in the trash are returned.

Default50

Maximum pages

Fail when one asset type needs more pages than this. Default 50. A partial result is never returned.

Possible Values
TITLELAST_VIEWED_BY_MECREATE_TIMELAST_ACCESSED_TIMEID

Order by

Sort field sent to the API. TITLE, LAST_VIEWED_BY_ME, CREATE_TIME, LAST_ACCESSED_TIME, or ID.

Owner

Email of the asset owner.

Page size

Number of assets to request per page. Must be at least 1. The API default is 1000.

Service account JSON

Google service account key JSON. Read tasks request https://www.googleapis.com/auth/datastudio.readonly. Add and Revoke request https://www.googleapis.com/auth/datastudio. Grant the scope through domain-wide delegation in a Google Workspace or Cloud Identity organization. Use this or accessToken.

Delegated user

Workspace user email the service account impersonates. Required for domain-wide delegation. Ignored when accessToken is set.

Search string

Matched against the asset title and description. Also accepts the API advanced filters, such as creator: me or parentWorkspace: <id>.

Defaulthttps://oauth2.googleapis.com/token

Token URI

OAuth token endpoint used to exchange a service account JWT.

First asset

Set only when fetchType is FETCH_ONE.

Definitions
assetTypestring
Possible Values
REPORTDATA_SOURCEUNKNOWN

Asset type

REPORT or DATA_SOURCE. An unexpected API value is UNKNOWN, so one asset does not fail the whole response.

createTimestring
Formatdate-time

Creation time

creatorstring

Creator email

descriptionstring

Description

namestring

Asset name

The Data Studio asset ID.

ownerstring

Owner email

titlestring

Title

trashedboolean

Trashed

True when the asset is in the trash.

updateTimestring
Formatdate-time

Update time

Assets

Set only when fetchType is FETCH.

Definitions
assetTypestring
Possible Values
REPORTDATA_SOURCEUNKNOWN

Asset type

REPORT or DATA_SOURCE. An unexpected API value is UNKNOWN, so one asset does not fail the whole response.

createTimestring
Formatdate-time

Creation time

creatorstring

Creator email

descriptionstring

Description

namestring

Asset name

The Data Studio asset ID.

ownerstring

Owner email

titlestring

Title

trashedboolean

Trashed

True when the asset is in the trash.

updateTimestring
Formatdate-time

Update time

Number of assets

Formaturi

Internal storage URI

Ion file of the assets. Set only when fetchType is STORE.