Class Info

  • The Info object stores configuration data that influences how information is displayed in Data Studio.

  • Developers can utilize the setId and setText methods to define the unique identifier and descriptive text for a configuration entry within the Info object.

  • The Info object uses a builder pattern, allowing developers to chain methods together for streamlined configuration.

Info

Contains info data for the config. Its properties determine how the info is displayed in Data Studio.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info1 = config.newInfo().setId('info1').setText(
    'This text gives some context on the configuration.');

Methods

MethodReturn typeBrief description
setId(id)InfoSets the unique ID for this configuration entry.
setText(text)InfoSets the text for this configuration entry.

Detailed documentation

setId(id)

Sets the unique ID for this configuration entry.

Parameters

NameTypeDescription
idStringThe ID to set.

Return

Info — This builder, for chaining.


setText(text)

Sets the text for this configuration entry.

Parameters

NameTypeDescription
textStringThe text to set.

Return

Info — This builder, for chaining.