Data Studio Service

Data Studio

Ce service permet aux scripts d'accéder aux connecteurs de la communauté Data Studio et de les modifier.

Classes

Nom	Brève description
AggregationType	Énumération qui définit les types d'agrégation pouvant être définis pour un Field.
AuthType	Énumération qui définit les types d'authentification pouvant être définis pour un connecteur.
BigQueryConfig	Objet de configuration pour un connecteur BigQuery natif.
BigQueryParameterType	Énumération qui définit les types de paramètres BigQuery que vous pouvez définir.
Checkbox	Contient des informations sur les cases à cocher pour la configuration.
CommunityConnector	CommunityConnector permet aux scripts d'accéder aux outils de création et aux utilitaires pour faciliter le développement de connecteurs de communauté pour Data Studio.
Config	Contient les entrées de configuration d'un connecteur.
DataStudioApp	DataStudioApp permet aux scripts d'interagir avec les fonctionnalités de Data Studio destinées aux développeurs.
DebugError	Erreur visible uniquement par les administrateurs du connecteur.
Field	Contient des données liées aux champs.
FieldType	Énumération qui définit les types pouvant être définis pour un Field.
Fields	Contient un ensemble de Field pour un connecteur de communauté.
GetAuthTypeResponse	Compilateur permettant de créer une réponse getAuthType() pour votre projet de script.
GetDataResponse	Compilateur permettant de créer une réponse getData() pour votre projet de script.
GetSchemaResponse	Compilateur permettant de créer une réponse getSchema() pour votre projet de script.
Info	Contient les données d'informations pour la configuration.
OptionBuilder	Compilateur permettant de créer des options pour les SelectSingle et les SelectMultiple.
SelectMultiple	Contient des informations de sélection multiple pour la configuration.
SelectSingle	Contient certaines informations uniques pour la configuration.
SetCredentialsResponse	Compilateur permettant de créer une réponse setCredentials() pour votre projet de script.
TextArea	Contient les informations de la zone de texte pour la configuration.
TextInput	Contient les informations de saisie de texte pour la configuration.
UserError	Erreur affichée aux utilisateurs du connecteur.

AggregationType

Propriétés

Propriété	Type	Description
AVG	Enum	Moyenne.
COUNT	Enum	Nombre.
COUNT_DISTINCT	Enum	Valeurs distinctes.
MAX	Enum	Max.
MIN	Enum	Min.
SUM	Enum	Somme.
AUTO	Enum	Auto

AuthType

Propriétés

Propriété	Type	Description
NONE	Enum	Aucune autorisation n'est requise.
OAUTH2	Enum	Autorisation OAuth2 requise.
USER_PASS	Enum	Vous devez fournir un nom d'utilisateur et un mot de passe.
PATH_USER_PASS	Enum	Nom d'utilisateur, chemin d'accès et mot de passe requis.
PATH_KEY	Enum	Veuillez indiquer le chemin d'accès et la clé.
KEY	Enum	Clé ou jeton API requis.
USER_TOKEN	Enum	Nom d'utilisateur et jeton requis.

BigQueryConfig

Méthodes

Méthode	Type renvoyé	Brève description
addQueryParameter(name, type, value)	BigQueryConfig	Ajoute un paramètre de requête à ce BigQueryConfig.
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
printJson()	String	Affiche la représentation JSON de cet objet.
setAccessToken(accessToken)	BigQueryConfig	Définit le jeton d'accès de ce BigQueryConfig.
setBillingProjectId(billingProjectId)	BigQueryConfig	Définit l'ID du projet de facturation de ce BigQueryConfig.
setQuery(query)	BigQueryConfig	Définit la requête SQL de ce BigQueryConfig.
setUseStandardSql(useStandardSql)	BigQueryConfig	Détermine si la requête est interprétée comme du SQL standard ou ancien.

BigQueryParameterType

Propriétés

Propriété	Type	Description
STRING	Enum	Chaîne.
INT64	Enum	Entier de 64 bits.
BOOL	Enum	Valeur booléenne.
FLOAT64	Enum	Nombre à virgule flottante de 64 bits.

Checkbox

Méthodes

Méthode	Type renvoyé	Brève description
setAllowOverride(allowOverride)	Checkbox	Permet de remplacer cette entrée de configuration.
setHelpText(helpText)	Checkbox	Définit le texte d'aide pour cette entrée de configuration.
setId(id)	Checkbox	Définit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)	Checkbox	Définit l'état dynamique de cette entrée de configuration.
setName(name)	Checkbox	Définit le nom à afficher pour cette entrée de configuration.

CommunityConnector

Propriétés

Propriété	Type	Description
AggregationType	AggregationType	Énumération AggregationType.
AuthType	AuthType	Énumération AuthType.
BigQueryParameterType	BigQueryParameterType	Énumération BigQueryParameterType.
FieldType	FieldType	Énumération FieldType.

Méthodes

Méthode	Type renvoyé	Brève description
getConfig()	Config	Renvoie un objet Config.
getFields()	Fields	Renvoie un objet Fields.
newAuthTypeResponse()	GetAuthTypeResponse	Renvoie un nouvel objet GetAuthTypeResponse.
newBigQueryConfig()	BigQueryConfig	Renvoie un nouvel objet BigQueryConfig.
newDebugError()	DebugError	Renvoie un nouvel objet DebugError.
newGetDataResponse()	GetDataResponse	Renvoie un nouvel objet GetDataResponse.
newGetSchemaResponse()	GetSchemaResponse	Renvoie un nouvel objet GetSchemaResponse.
newSetCredentialsResponse()	SetCredentialsResponse	Renvoie un nouvel objet SetCredentialsResponse.
newUserError()	UserError	Renvoie un nouvel objet UserError.

Config

Méthodes

Méthode	Type renvoyé	Brève description
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
newCheckbox()	Checkbox	Renvoie une nouvelle entrée de configuration de case à cocher.
newInfo()	Info	Renvoie une nouvelle entrée de configuration d'informations.
newOptionBuilder()	OptionBuilder	Renvoie un nouveau compilateur d'options.
newSelectMultiple()	SelectMultiple	Renvoie une nouvelle entrée de configuration à sélection multiple.
newSelectSingle()	SelectSingle	Renvoie une nouvelle entrée de configuration à sélection unique.
newTextArea()	TextArea	Renvoie une nouvelle entrée de configuration de zone de texte.
newTextInput()	TextInput	Renvoie une nouvelle entrée de configuration d'entrée de texte.
printJson()	String	Affiche la représentation JSON de cet objet.
setDateRangeRequired(dateRangeRequired)	Config	Si la valeur est true, une plage de dates est fournie pour les requêtes getData().
setIsSteppedConfig(isSteppedConfig)	Config	Si true, getConfig() est appelé à nouveau avec la configuration utilisateur actuelle.

DataStudioApp

Méthodes

Méthode	Type renvoyé	Brève description
createCommunityConnector()	CommunityConnector	Crée un connecteur de communauté.

DebugError

Méthodes

Méthode	Type renvoyé	Brève description
printJson()	String	Affiche la représentation JSON de cet objet.
setText(text)	DebugError	Définit le texte de l'erreur de débogage, qui n'est affiché qu'aux administrateurs.
throwException()	void	Déclenche la génération de cette exception.

Field

Méthodes

Méthode	Type renvoyé	Brève description
getAggregation()	AggregationType	Renvoie le AggregationType de cette Field.
getDescription()	String	Renvoie la description de cet objet Field.
getFormula()	String	Renvoie la formule de cet objet Field.
getGroup()	String	Renvoie le groupe de cet objet Field.
getId()	String	Renvoie l'ID de cet objet Field.
getIsReaggregatable()	Boolean	Renvoie true si ce champ peut être réagrégé, ou false dans le cas contraire.
getName()	String	Renvoie le nom de cet objet Field.
getType()	FieldType	Renvoie le FieldType de cette Field.
isDefault()	Boolean	Renvoie true si ce Field est la métrique ou la dimension par défaut.
isDimension()	Boolean	Renvoie true si ce champ est une dimension.
isHidden()	Boolean	Renvoie true si ce Field est masqué.
isMetric()	Boolean	Renvoie true si ce champ est une métrique.
setAggregation(aggregation)	Field	Définit le type d'agrégation de ce Field.
setDescription(description)	Field	Définit la description de ce Field.
setFormula(formula)	Field	Définit la formule de cette Field.
setGroup(group)	Field	Définit le groupe de ce Field.
setId(id)	Field	Définit l'ID de ce Field.
setIsHidden(isHidden)	Field	Définit l'état masqué de cet Field.
setIsReaggregatable(isReaggregatable)	Field	Définit l'état d'agrégation autorisée pour un Field.
setName(name)	Field	Définit le nom de cet objet Field.
setType(type)	Field	Définit le FieldType de ce Field.

FieldType

Propriétés

Propriété	Type	Description
YEAR	Enum	Année au format AAAA, par exemple 2017.
YEAR_QUARTER	Enum	Année et trimestre au format AAAAT (par exemple, 20171).
YEAR_MONTH	Enum	Année et mois au format AAAAMM, par exemple 201703.
YEAR_WEEK	Enum	Année et semaine au format AAAAww, par exemple 201707.
YEAR_MONTH_DAY	Enum	Année, mois et jour au format AAAAMMJJ, par exemple 20170317.
YEAR_MONTH_DAY_HOUR	Enum	Année, mois, jour et heure au format AAAAMMJJHH, par exemple 2017031703.
YEAR_MONTH_DAY_MINUTE	Enum	Année, mois, jour, heure et minute au format AAAAMMJJHHmm, par exemple 201703170230.
YEAR_MONTH_DAY_SECOND	Enum	Année, mois, jour, heure, minute et seconde au format AAAAMMJJHHmmss, par exemple 20170317023017.
QUARTER	Enum	Trimestre au format 1, 2, 3 ou 4.
MONTH	Enum	Mois au format MM, par exemple "03".
WEEK	Enum	Semaine au format "ww", par exemple "07".
MONTH_DAY	Enum	Mois et jour au format MMJJ, par exemple 0317.
DAY_OF_WEEK	Enum	Nombre compris entre 0 et 6,où 0 correspond au dimanche.
DAY	Enum	Jour au format JJ, par exemple "17".
HOUR	Enum	Heure au format HH, par exemple 13.
MINUTE	Enum	Minute au format mm, par exemple "12".
DURATION	Enum	Durée en secondes.
COUNTRY	Enum	Un pays, comme les États-Unis.
COUNTRY_CODE	Enum	Code pays, tel que "US".
CONTINENT	Enum	Un continent, comme les Amériques.
CONTINENT_CODE	Enum	Un code de continent, tel que 019.
SUB_CONTINENT	Enum	Un sous-continent tel que l'Amérique du Nord.
SUB_CONTINENT_CODE	Enum	Code de sous-continent, par exemple "003".
REGION	Enum	Une région telle que la Californie.
REGION_CODE	Enum	Un code de région, tel que CA.
CITY	Enum	Une ville comme Mountain View.
CITY_CODE	Enum	Un code de ville, tel que 1014044.
METRO	Enum	Une zone métropolitaine, comme San Francisco-Oakland-San Jose CA.
METRO_CODE	Enum	Un code d'agglomération, par exemple 200807.
LATITUDE_LONGITUDE	Enum	Paire de latitude et de longitude, par exemple 51.5074, -0.1278.
NUMBER	Enum	Nombre décimal.
PERCENT	Enum	Pourcentage décimal (peut être supérieur à 1,0).
TEXT	Enum	Texte au format libre.
BOOLEAN	Enum	Valeur booléenne true ou false.
URL	Enum	URL sous forme de texte, par exemple https://google.com.
HYPERLINK	Enum	Un lien hypertexte.
IMAGE	Enum	Image.
IMAGE_LINK	Enum	Un lien image.
CURRENCY_AED	Enum	Devise : AED
CURRENCY_ALL	Enum	Devise de ALL.
CURRENCY_ARS	Enum	Devise : ARS
CURRENCY_AUD	Enum	Devise : AUD
CURRENCY_BDT	Enum	Devise : BDT
CURRENCY_BGN	Enum	Devise : BGN
CURRENCY_BOB	Enum	Devise de BOB.
CURRENCY_BRL	Enum	Devise autre que le réal brésilien
CURRENCY_CAD	Enum	Devise à partir du CAD.
CURRENCY_CDF	Enum	Devise du CDF.
CURRENCY_CHF	Enum	Devise : CHF
CURRENCY_CLP	Enum	Devise : CLP
CURRENCY_CNY	Enum	Devise à partir du CNY.
CURRENCY_COP	Enum	Devise à partir de COP.
CURRENCY_CRC	Enum	Devise du compte CRC.
CURRENCY_CZK	Enum	Devise à partir de CZK.
CURRENCY_DKK	Enum	Devise : DKK.
CURRENCY_DOP	Enum	Devise du DOP.
CURRENCY_EGP	Enum	Devise : EGP
CURRENCY_ETB	Enum	Devise : ETB.
CURRENCY_EUR	Enum	Devise à partir de l'EUR.
CURRENCY_GBP	Enum	Devise : GBP
CURRENCY_HKD	Enum	Devise à partir de HKD.
CURRENCY_HRK	Enum	Devise à partir de HRK.
CURRENCY_HUF	Enum	Devise à partir de HUF.
CURRENCY_IDR	Enum	Devise à partir de l'IDR.
CURRENCY_ILS	Enum	Devise à partir de ILS.
CURRENCY_INR	Enum	Devise à partir de l'INR.
CURRENCY_IRR	Enum	Devise du revenu annuel récurrent.
CURRENCY_ISK	Enum	Devise : ISK
CURRENCY_JMD	Enum	Devise de JMD.
CURRENCY_JPY	Enum	Devise à partir de JPY.
CURRENCY_KRW	Enum	Devise : KRW.
CURRENCY_LKR	Enum	Devise : LKR
CURRENCY_LTL	Enum	Devise de LTL.
CURRENCY_MNT	Enum	Devise de MNT.
CURRENCY_MVR	Enum	Devise de la MVR.
CURRENCY_MXN	Enum	Devise : MXN.
CURRENCY_MYR	Enum	Devise : MYR
CURRENCY_NGN	Enum	Devise : NGN
CURRENCY_NOK	Enum	Devise NOK.
CURRENCY_NZD	Enum	Devise : NZD
CURRENCY_PAB	Enum	Devise de PAB.
CURRENCY_PEN	Enum	Devise : PEN
CURRENCY_PHP	Enum	Devise de PHP.
CURRENCY_PKR	Enum	Devise : PKR
CURRENCY_PLN	Enum	Devise : PLN
CURRENCY_RON	Enum	Devise : RON
CURRENCY_RSD	Enum	Devise : RSD
CURRENCY_RUB	Enum	Devise : RUB
CURRENCY_SAR	Enum	Devise : SAR
CURRENCY_SEK	Enum	Devise : SEK
CURRENCY_SGD	Enum	Devise à partir de SGD.
CURRENCY_THB	Enum	Devise : THB
CURRENCY_TRY	Enum	Devise à partir de TRY.
CURRENCY_TWD	Enum	Devise : TWD
CURRENCY_TZS	Enum	Devise : TZS
CURRENCY_UAH	Enum	Devise : UAH
CURRENCY_USD	Enum	Devise autre que l'USD.
CURRENCY_UYU	Enum	Devise : UYU
CURRENCY_VEF	Enum	Devise de la VEF.
CURRENCY_VND	Enum	Devise : VND
CURRENCY_YER	Enum	Devise : YER
CURRENCY_ZAR	Enum	Devise : ZAR

Fields

Méthodes

Méthode	Type renvoyé	Brève description
asArray()	Field[]	Renvoie une vue de cet objet sous forme de tableau.
build()	Object[]	Valide cet objet et le renvoie au format requis par Data Studio.
forIds(ids)	Fields	Renvoie un nouvel objet Fields filtré sur les Field dont l'ID figure dans ids.
getDefaultDimension()	Field	Renvoie la dimension par défaut à utiliser pour l'ensemble des champs.
getDefaultMetric()	Field	Renvoie la métrique par défaut à utiliser pour l'ensemble des champs.
getFieldById(fieldId)	Field	Renvoie un champ avec un ID donné, ou null si aucun champ avec cet ID ne se trouve dans cet objet Fields.
newDimension()	Field	Renvoie une nouvelle dimension Field.
newMetric()	Field	Renvoie une nouvelle métrique Field.
setDefaultDimension(fieldId)	void	Définit la dimension par défaut à utiliser pour l'ensemble de champs.
setDefaultMetric(fieldId)	void	Définit la métrique par défaut à utiliser pour l'ensemble de champs.

GetAuthTypeResponse

Méthodes

Méthode	Type renvoyé	Brève description
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
printJson()	String	Affiche la représentation JSON de cet objet.
setAuthType(authType)	GetAuthTypeResponse	Définit le AuthType du compilateur.
setHelpUrl(helpUrl)	GetAuthTypeResponse	Définit l'URL d'aide du compilateur.

GetDataResponse

Méthodes

Méthode	Type renvoyé	Brève description
addAllRows(rows)	GetDataResponse	Ajoute plusieurs lignes de données à ce GetDataResponse.
addRow(row)	GetDataResponse	Ajoute une ligne de données à ce GetDataResponse.
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
setFields(fields)	GetDataResponse	Définit le Fields du compilateur.
setFiltersApplied(filtersApplied)	GetDataResponse	Définit l'état des filtres appliqués pour ce générateur.

GetSchemaResponse

Méthodes

Méthode	Type renvoyé	Brève description
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
printJson()	String	Affiche la représentation JSON de cet objet.
setFields(fields)	GetSchemaResponse	Définit le Fields du compilateur.

Info

Méthodes

Méthode	Type renvoyé	Brève description
setId(id)	Info	Définit l'ID unique de cette entrée de configuration.
setText(text)	Info	Définit le texte de cette entrée de configuration.

OptionBuilder

Méthodes

Méthode	Type renvoyé	Brève description
setLabel(label)	OptionBuilder	Définit le libellé de ce générateur d'options.
setValue(value)	OptionBuilder	Définit la valeur de ce générateur d'options.

SelectMultiple

Méthodes

Méthode	Type renvoyé	Brève description
addOption(optionBuilder)	SelectMultiple	Ajoute une option de sélection.
setAllowOverride(allowOverride)	SelectMultiple	Permet de remplacer cette entrée de configuration.
setHelpText(helpText)	SelectMultiple	Définit le texte d'aide pour cette entrée de configuration.
setId(id)	SelectMultiple	Définit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)	SelectMultiple	Définit l'état dynamique de cette entrée de configuration.
setName(name)	SelectMultiple	Définit le nom à afficher pour cette entrée de configuration.

SelectSingle

Méthodes

Méthode	Type renvoyé	Brève description
addOption(optionBuilder)	SelectSingle	Ajoute une option de sélection.
setAllowOverride(allowOverride)	SelectSingle	Permet de remplacer cette entrée de configuration.
setHelpText(helpText)	SelectSingle	Définit le texte d'aide pour cette entrée de configuration.
setId(id)	SelectSingle	Définit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)	SelectSingle	Définit l'état dynamique de cette entrée de configuration.
setName(name)	SelectSingle	Définit le nom à afficher pour cette entrée de configuration.

SetCredentialsResponse

Méthodes

Méthode	Type renvoyé	Brève description
build()	Object	Valide cet objet et le renvoie au format requis par Data Studio.
printJson()	String	Affiche la représentation JSON de cet objet.
setIsValid(isValid)	SetCredentialsResponse	Définit l'état valide de cet objet SetCredentialsResponse.

TextArea

Méthodes

Méthode	Type renvoyé	Brève description
setAllowOverride(allowOverride)	TextArea	Permet de remplacer cette entrée de configuration.
setHelpText(helpText)	TextArea	Définit le texte d'aide pour cette entrée de configuration.
setId(id)	TextArea	Définit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)	TextArea	Définit l'état dynamique de cette entrée de configuration.
setName(name)	TextArea	Définit le nom à afficher pour cette entrée de configuration.
setPlaceholder(placeholder)	TextArea	Définit le texte d'espace réservé pour cette entrée de configuration.

TextInput

Méthodes

Méthode	Type renvoyé	Brève description
setAllowOverride(allowOverride)	TextInput	Permet de remplacer cette entrée de configuration.
setHelpText(helpText)	TextInput	Définit le texte d'aide pour cette entrée de configuration.
setId(id)	TextInput	Définit l'ID unique de cette entrée de configuration.
setIsDynamic(isDynamic)	TextInput	Définit l'état dynamique de cette entrée de configuration.
setName(name)	TextInput	Définit le nom à afficher pour cette entrée de configuration.
setPlaceholder(placeholder)	TextInput	Définit le texte d'espace réservé pour cette entrée de configuration.

UserError

Méthodes

Méthode	Type renvoyé	Brève description
printJson()	String	Affiche la représentation JSON de cet objet.
setDebugText(text)	UserError	Définit le texte de l'erreur de débogage, qui n'est affiché qu'aux administrateurs.
setText(text)	UserError	Définit le texte de l'erreur utilisateur.
throwException()	void	Déclenche la génération de cette exception.