Data Studio Service

Data Studio

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

Classes

NomBrève description
AggregationTypeÉnumération qui définit les types d'agrégation pouvant être définis pour une Field.
AuthTypeÉnumération définissant les types d'authentification pouvant être définis pour un connecteur.
BigQueryConfigObjet de configuration pour un connecteur BigQuery natif.
BigQueryParameterTypeÉnumération qui définit les types de paramètres BigQuery que vous pouvez définir.
CheckboxContient des informations sur la case à cocher pour la configuration.
CommunityConnectorCommunityConnector permet aux scripts d'accéder à des compilateurs et à des utilitaires qui facilitent le développement de connecteurs de communauté pour Data Studio.
ConfigContient les entrées de configuration d'un connecteur.
DataStudioAppDataStudioApp permet aux scripts d'interagir avec les fonctionnalités de Data Studio destinées aux développeurs.
DebugErrorErreur visible uniquement par les administrateurs du connecteur.
FieldContient des données liées aux champs.
FieldTypeÉnumération qui définit les types pouvant être définis pour un Field.
FieldsContient un ensemble de Field pour un connecteur de communauté.
GetAuthTypeResponseCompilateur permettant de créer une réponse getAuthType() pour votre projet de script.
GetDataResponseCompilateur permettant de créer une réponse getData() pour votre projet de script.
GetSchemaResponseCompilateur permettant de créer une réponse getSchema() pour votre projet de script.
InfoContient des données d'informations pour la configuration.
OptionBuilderCompilateur permettant de créer des options pour les SelectSingle et les SelectMultiple.
SelectMultipleContient la sélection de plusieurs informations pour la configuration.
SelectSingleContient une seule information sélectionnée pour la configuration.
SetCredentialsResponseCompilateur permettant de créer une réponse setCredentials() pour votre projet de script.
TextAreaContient des informations sur la zone de texte pour la configuration.
TextInputContient des informations d'entrée de texte pour la configuration.
UserErrorErreur présentée aux utilisateurs du connecteur.

AggregationType

Propriétés

PropriétéTypeDescription
AVGEnumMoyenne.
COUNTEnumDécompte.
COUNT_DISTINCTEnumValeurs distinctes.
MAXEnumCPC
MINEnumMin.
SUMEnumSomme.
AUTOEnumAuto

AuthType

Propriétés

PropriétéTypeDescription
NONEEnumAucune autorisation n'est requise.
OAUTH2EnumAutorisation OAuth2 requise.
USER_PASSEnumNom d'utilisateur et mot de passe requis.
PATH_USER_PASSEnumNom d'utilisateur, chemin d'accès et mot de passe requis.
PATH_KEYEnumChemin d'accès et clé requis.
KEYEnumClé API ou jeton requis.
USER_TOKENEnumNom d'utilisateur et jeton requis.

BigQueryConfig

Méthodes

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

BigQueryParameterType

Propriétés

PropriétéTypeDescription
STRINGEnumChaîne.
INT64EnumEntier de 64 bits.
BOOLEnumValeur booléenne.
FLOAT64EnumNombre à virgule flottante de 64 bits.

Checkbox

Méthodes

MéthodeType renvoyéBrève description
setAllowOverride(allowOverride)CheckboxActive le forçage pour cette entrée de configuration.
setHelpText(helpText)CheckboxDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)CheckboxDéfinit l'identifiant unique de cette entrée de configuration.
setIsDynamic(isDynamic)CheckboxDéfinit l'état dynamique de cette entrée de configuration.
setName(name)CheckboxDéfinit le nom à afficher pour cette entrée de configuration.

CommunityConnector

Propriétés

PropriétéTypeDescription
AggregationTypeAggregationTypeÉnumération AggregationType.
AuthTypeAuthTypeÉnumération AuthType.
BigQueryParameterTypeBigQueryParameterTypeÉnumération BigQueryParameterType.
FieldTypeFieldTypeÉnumération FieldType.

Méthodes

MéthodeType renvoyéBrève description
getConfig()ConfigRenvoie un objet Config.
getFields()FieldsRenvoie un objet Fields.
newAuthTypeResponse()GetAuthTypeResponseRenvoie un nouvel objet GetAuthTypeResponse.
newBigQueryConfig()BigQueryConfigRenvoie un nouvel objet BigQueryConfig.
newDebugError()DebugErrorRenvoie un nouvel objet DebugError.
newGetDataResponse()GetDataResponseRenvoie un nouvel objet GetDataResponse.
newGetSchemaResponse()GetSchemaResponseRenvoie un nouvel objet GetSchemaResponse.
newSetCredentialsResponse()SetCredentialsResponseRenvoie un nouvel objet SetCredentialsResponse.
newUserError()UserErrorRenvoie un nouvel objet UserError.

Config

Méthodes

MéthodeType renvoyéBrève description
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
newCheckbox()CheckboxRenvoie une nouvelle entrée de configuration de case à cocher.
newInfo()InfoRenvoie une nouvelle entrée de configuration des informations.
newOptionBuilder()OptionBuilderRenvoie un nouveau compilateur d'options.
newSelectMultiple()SelectMultipleRenvoie une nouvelle entrée de configuration "select multiple".
newSelectSingle()SelectSingleRenvoie une nouvelle entrée de configuration "select unique".
newTextArea()TextAreaRenvoie une nouvelle entrée de configuration de zone de texte.
newTextInput()TextInputRenvoie une nouvelle entrée de configuration d'entrée de texte.
printJson()StringAffiche la représentation JSON de cet objet.
setDateRangeRequired(dateRangeRequired)ConfigSi la valeur est true, une plage de dates est fournie pour les requêtes getData().
setIsSteppedConfig(isSteppedConfig)ConfigSi la valeur est true, getConfig() est appelé à nouveau avec la configuration utilisateur actuelle.

DataStudioApp

Méthodes

MéthodeType renvoyéBrève description
createCommunityConnector()CommunityConnectorCrée un connecteur de communauté.

DebugError

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.
setText(text)DebugErrorDéfinit le texte de l'erreur de débogage, qui ne s'affiche que pour les administrateurs.
throwException()voidDéclenche cette exception.

Field

Méthodes

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

FieldType

Propriétés

PropriétéTypeDescription
YEAREnumAnnée au format AAAA, par exemple 2017.
YEAR_QUARTEREnumAnnée et trimestre au format AAAAQ, tel que 20171.
YEAR_MONTHEnumAnnée et mois au format AAAAMM (par exemple, 201703).
YEAR_WEEKEnumAnnée et semaine au format AAAAss (par exemple, 201707).
YEAR_MONTH_DAYEnumAnnée, mois et jour au format AAAAMMJJ, par exemple 20170317.
YEAR_MONTH_DAY_HOUREnumAnnée, mois, jour et heure au format AAAAMMJJHH (par exemple, 2017031703).
YEAR_MONTH_DAY_MINUTEEnumAnnée, mois, jour, heure et minute au format AAAAMMJJHHmm, par exemple 201703170230.
YEAR_MONTH_DAY_SECONDEnumAnnée, mois, jour, heure, minute et seconde au format AAAAMMJJHHmmss, par exemple 20170317023017.
QUARTEREnumle trimestre au format 1, 2, 3 ou 4).
MONTHEnumMois au format MM tel que 03.
WEEKEnumSemaine au format ww, par exemple 07.
MONTH_DAYEnumMois et jour au format MMJJ, par exemple 0317.
DAY_OF_WEEKEnumNombre compris entre [0,6], 0 représentant dimanche.
DAYEnumJour au format JJ, tel que 17.
HOUREnumHeure au format HH (13, par exemple).
MINUTEEnumMinutes au format mm (par exemple, 12).
DURATIONEnumDurée, en secondes.
COUNTRYEnumPays tel que les États-Unis.
COUNTRY_CODEEnumUn code pays, tel que US.
CONTINENTEnumUn continent tel que le continent américain.
CONTINENT_CODEEnumUn code de continent, tel que 019.
SUB_CONTINENTEnumSous-continent tel que l'Amérique du Nord.
SUB_CONTINENT_CODEEnumUn code de sous-continent, tel que 003.
REGIONEnumUne région telle que la Californie.
REGION_CODEEnumUn code régional, tel que CA.
CITYEnumune ville telle que Mountain View ;
CITY_CODEEnumUn code de ville, par exemple 1014044
METROEnumAgglomération comme San Francisco-Oakland-San Jose, Californie.
METRO_CODEEnumCode d'agglomération tel que 200807
LATITUDE_LONGITUDEEnumPaire latitude/longitude telle que 51.5074, -0.1278.
NUMBEREnumNombre décimal.
PERCENTEnumPourcentage décimal (peut être supérieur à 1).
TEXTEnumTexte au format libre.
BOOLEANEnumUne valeur booléenne true ou false.
URLEnumURL sous forme de texte telle que https://google.com.
HYPERLINKEnumUn lien hypertexte.
IMAGEEnumImage.
IMAGE_LINKEnumLien image.
CURRENCY_AEDEnumDevise de l'AED.
CURRENCY_ALLEnumDevise : ALL.
CURRENCY_ARSEnumDevise de l'ARS.
CURRENCY_AUDEnumDevise : AUD.
CURRENCY_BDTEnumDevise du BDT.
CURRENCY_BGNEnumDevise : BGN.
CURRENCY_BOBEnumDevise de la devise BOB.
CURRENCY_BRLEnumDevise : BRL.
CURRENCY_CADEnumDevise : CAD.
CURRENCY_CDFEnumDevise de la CDF.
CURRENCY_CHFEnumDevise en CHF.
CURRENCY_CLPEnumDevise de la peso chilien.
CURRENCY_CNYEnumDevise : CNY.
CURRENCY_COPEnumDevise du COP.
CURRENCY_CRCEnumDevise du CRC.
CURRENCY_CZKEnumDevise : CZK.
CURRENCY_DKKEnumDevise de la devise DKK.
CURRENCY_DOPEnumDevise du DOP.
CURRENCY_EGPEnumDevise du EGP.
CURRENCY_ETBEnumDevise de l'ETB.
CURRENCY_EUREnumDevise : EUR.
CURRENCY_GBPEnumDevise de la devise GBP.
CURRENCY_HKDEnumDevise de la devise HKD.
CURRENCY_HRKEnumDevise de la kuna (HRK).
CURRENCY_HUFEnumDevise en HUF.
CURRENCY_IDREnumDevise exprimée en IDR.
CURRENCY_ILSEnumDevise de l'ILS.
CURRENCY_INREnumDevise de l'INR.
CURRENCY_IRREnumDevise de l'IRR.
CURRENCY_ISKEnumDevise de l'ISK.
CURRENCY_JMDEnumDevise de la devise JMD.
CURRENCY_JPYEnumDevise : JPY.
CURRENCY_KRWEnumDevise : KRW.
CURRENCY_LKREnumDevise de la devise LKR.
CURRENCY_LTLEnumDevise de LTL.
CURRENCY_MNTEnumDevise de MNT.
CURRENCY_MVREnumDevise du MVR.
CURRENCY_MXNEnumDevise : MXN.
CURRENCY_MYREnumDevise : MYR.
CURRENCY_NGNEnumDevise du NGN.
CURRENCY_NOKEnumDevise : NOK.
CURRENCY_NZDEnumDevise de : NZD.
CURRENCY_PABEnumDevise du PAB.
CURRENCY_PENEnumDevise : PEN.
CURRENCY_PHPEnumDevise : PHP.
CURRENCY_PKREnumDevise : PKR.
CURRENCY_PLNEnumDevise : PLN.
CURRENCY_RONEnumDevise : RON.
CURRENCY_RSDEnumDevise de la devise RSD.
CURRENCY_RUBEnumDevise du RUB.
CURRENCY_SAREnumDevise du SAR.
CURRENCY_SEKEnumDevise de la devise SEK.
CURRENCY_SGDEnumDevise : SGD.
CURRENCY_THBEnumDevise : THB.
CURRENCY_TRYEnumDevise : TRY.
CURRENCY_TWDEnumDevise : TWD.
CURRENCY_TZSEnumDevise : TZS.
CURRENCY_UAHEnumDevise de l'UAH.
CURRENCY_USDEnumDevise : USD.
CURRENCY_UYUEnumDevise de l'UYU.
CURRENCY_VEFEnumDevise du VEF.
CURRENCY_VNDEnumDevise : VND.
CURRENCY_YEREnumDevise : YER.
CURRENCY_ZAREnumDevise : ZAR.

Fields

Méthodes

MéthodeType 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)FieldsRenvoie un nouvel objet Fields filtré sur Field avec un ID dans ids.
getDefaultDimension()FieldRenvoie la dimension par défaut à utiliser pour l'ensemble des champs.
getDefaultMetric()FieldRenvoie la métrique par défaut à utiliser pour l'ensemble des champs.
getFieldById(fieldId)FieldRenvoie un champ avec un ID donné, ou null si cet objet Fields ne contient aucun champ avec cet ID.
newDimension()FieldRenvoie une nouvelle dimension Field.
newMetric()FieldRenvoie une nouvelle métrique Field.
setDefaultDimension(fieldId)voidDéfinit la dimension par défaut à utiliser pour l'ensemble de champs.
setDefaultMetric(fieldId)voidDéfinit la métrique par défaut à utiliser pour l'ensemble des champs.

GetAuthTypeResponse

Méthodes

MéthodeType renvoyéBrève description
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
printJson()StringAffiche la représentation JSON de cet objet.
setAuthType(authType)GetAuthTypeResponseDéfinit les AuthType du compilateur.
setHelpUrl(helpUrl)GetAuthTypeResponseDéfinit l'URL d'aide du compilateur.

GetDataResponse

Méthodes

MéthodeType renvoyéBrève description
addAllRows(rows)GetDataResponseAjoute plusieurs lignes de données à ce GetDataResponse.
addRow(row)GetDataResponseAjoute une ligne de données à ce GetDataResponse.
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
setFields(fields)GetDataResponseDéfinit les Fields du compilateur.
setFiltersApplied(filtersApplied)GetDataResponseDéfinit l'état d'application des filtres pour ce compilateur.

GetSchemaResponse

Méthodes

MéthodeType renvoyéBrève description
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
printJson()StringAffiche la représentation JSON de cet objet.
setFields(fields)GetSchemaResponseDéfinit les Fields du compilateur.

Info

Méthodes

MéthodeType renvoyéBrève description
setId(id)InfoDéfinit l'identifiant unique de cette entrée de configuration.
setText(text)InfoDéfinit le texte de cette entrée de configuration.

OptionBuilder

Méthodes

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

SelectMultiple

Méthodes

MéthodeType renvoyéBrève description
addOption(optionBuilder)SelectMultipleAjoute une nouvelle option de sélection.
setAllowOverride(allowOverride)SelectMultipleActive le forçage pour cette entrée de configuration.
setHelpText(helpText)SelectMultipleDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)SelectMultipleDéfinit l'identifiant unique de cette entrée de configuration.
setIsDynamic(isDynamic)SelectMultipleDéfinit l'état dynamique de cette entrée de configuration.
setName(name)SelectMultipleDéfinit le nom à afficher pour cette entrée de configuration.

SelectSingle

Méthodes

MéthodeType renvoyéBrève description
addOption(optionBuilder)SelectSingleAjoute une nouvelle option de sélection.
setAllowOverride(allowOverride)SelectSingleActive le forçage pour cette entrée de configuration.
setHelpText(helpText)SelectSingleDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)SelectSingleDéfinit l'identifiant unique de cette entrée de configuration.
setIsDynamic(isDynamic)SelectSingleDéfinit l'état dynamique de cette entrée de configuration.
setName(name)SelectSingleDéfinit le nom à afficher pour cette entrée de configuration.

SetCredentialsResponse

Méthodes

MéthodeType renvoyéBrève description
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
printJson()StringAffiche la représentation JSON de cet objet.
setIsValid(isValid)SetCredentialsResponseDéfinit l'état valide de ce SetCredentialsResponse.

TextArea

Méthodes

MéthodeType renvoyéBrève description
setAllowOverride(allowOverride)TextAreaActive le forçage pour cette entrée de configuration.
setHelpText(helpText)TextAreaDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)TextAreaDéfinit l'identifiant unique de cette entrée de configuration.
setIsDynamic(isDynamic)TextAreaDéfinit l'état dynamique de cette entrée de configuration.
setName(name)TextAreaDéfinit le nom à afficher pour cette entrée de configuration.
setPlaceholder(placeholder)TextAreaDéfinit le texte d'espace réservé pour cette entrée de configuration.

TextInput

Méthodes

MéthodeType renvoyéBrève description
setAllowOverride(allowOverride)TextInputActive le forçage pour cette entrée de configuration.
setHelpText(helpText)TextInputDéfinit le texte d'aide pour cette entrée de configuration.
setId(id)TextInputDéfinit l'identifiant unique de cette entrée de configuration.
setIsDynamic(isDynamic)TextInputDéfinit l'état dynamique de cette entrée de configuration.
setName(name)TextInputDéfinit le nom à afficher pour cette entrée de configuration.
setPlaceholder(placeholder)TextInputDéfinit le texte d'espace réservé pour cette entrée de configuration.

UserError

Méthodes

MéthodeType renvoyéBrève description
printJson()StringAffiche la représentation JSON de cet objet.
setDebugText(text)UserErrorDéfinit le texte de l'erreur de débogage, qui ne s'affiche que pour les administrateurs.
setText(text)UserErrorDéfinit le texte de l'erreur utilisateur.
throwException()voidDéclenche cette exception.