Google Data Studio Get

Google Data Studio Get

Certified

Get a Data Studio asset

Load metadata for one report or data source. The API has no get-by-id method, so this task walks search pages for each asset type and stops at the first name match. On a large organization that can be many pages. Live assets are searched first. includeTrashed then searches the trash, because the API returns only trashed assets when that flag is true. The task fails if a scan exceeds maxPages without a match.

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

Get report metadata

yaml
id: assets_get
namespace: company.team

inputs:
  - id: asset_id
    type: STRING

tasks:
  - id: get
    type: io.kestra.plugin.datastudio.assets.Get
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_JSON') }}"
    assetName: "{{ inputs.asset_id }}"
    assetTypes:
      - REPORT
Properties

Asset name

The Data Studio asset ID returned by Search as name.

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.

SubTypestring
Default["REPORT","DATA_SOURCE"]
Possible Values
REPORTDATA_SOURCEUNKNOWN

Asset types

Types to search while looking up the asset. Defaults to REPORT and DATA_SOURCE. UNKNOWN is output-only and is rejected here.

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.

Defaultfalse

Include trashed assets

When true, search live assets first and then the trash. The API's includeTrashed=true returns only trashed assets, so a trashed asset is not visible in the live scan. When false, trashed assets are not found.

Default50

Maximum pages

Fail when one asset type needs more pages than this before the name matches. Default 50.

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.

Defaulthttps://oauth2.googleapis.com/token

Token URI

OAuth token endpoint used to exchange a service account JWT.

Asset metadata

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