Google Data Studio Add

Google Data Studio Add

Certified

Grant Data Studio access

Add members to a role on a report or data source. role is VIEWER or EDITOR and applies to user: , group: , serviceAccount: , and domain: members. linkRole is LINK_VIEWER or LINK_EDITOR and applies only to allUsers and domain: members. One call uses one role, so named members and link members cannot be mixed. allUsers and domain: require allowLinkSharing: true.

yaml
type: io.kestra.plugin.datastudio.permissions.Add

Grant a group read access to a report

yaml
id: permissions_add
namespace: company.team

inputs:
  - id: asset_id
    type: STRING

tasks:
  - id: add
    type: io.kestra.plugin.datastudio.permissions.Add
    serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_JSON') }}"
    assetName: "{{ inputs.asset_id }}"
    members:
      - "group:analysts@acme.com"
    role: VIEWER
Properties

Asset name

The Data Studio asset ID.

SubTypestring

Members

Members to add. user: , group: , and serviceAccount: take role. allUsers takes linkRole. domain: takes role or linkRole. allUsers and domain: require allowLinkSharing.

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.

Defaultfalse

Allow link sharing

Permit allUsers, domain: members, and linkRole. Leave false unless the flow should make an asset public or domain-wide.

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.

Possible Values
LINK_VIEWERLINK_EDITOR

Link role

LINK_VIEWER or LINK_EDITOR. Used only when every member is allUsers or domain: . Requires allowLinkSharing. Do not set this when granting role to user: , group: , or serviceAccount: members.

DefaultVIEWER
Possible Values
VIEWEREDITOR

Role

Role to grant. VIEWER or EDITOR. OWNER, LINK_VIEWER, and LINK_EDITOR are not accepted here.

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.

SubTypearray

Updated permissions by role

Number of members on the asset after the update