Cette page a été traduite par l'API Cloud Translation.

Data Studio Service

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`	Enumé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`	Enumé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`	Le connecteur de la communauté permet aux scripts d'accéder aux outils de création et aux utilitaires pour faciliter le développement de connecteurs de la communauté pour Data Studio.
`Config`	Contient les entrées de configuration d'un connecteur.
`DataStudioApp`	L'application DataStudio permet aux scripts d'interagir avec les fonctionnalités Data Studio destinées aux développeurs.
`DebugError`	Erreur visible uniquement par les administrateurs du connecteur.
`Field`	Contient des données liées au champ.
`FieldType`	Énumération qui définit les types pouvant être définis pour un `Field`.
`Fields`	Inclut 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 des données d'informations pour la configuration.
`OptionBuilder`	Compilateur permettant de créer des options pour les `SelectSingle` et les `SelectMultiple`.
`SelectMultiple`	Contient plusieurs informations sélectionnées pour la configuration.
`SelectSingle`	Contient des informations spécifiques à la configuration.
`SetCredentialsResponse`	Compilateur permettant de créer une réponse `setCredentials()` pour votre projet de script.
`TextArea`	Contient des informations sur la zone de texte pour la configuration.
`TextInput`	Contient des informations sur la 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 requise.
`OAUTH2`	`Enum`	Autorisation OAuth2 requise.
`USER_PASS`	`Enum`	Nom d'utilisateur et mot de passe requis.
`PATH_USER_PASS`	`Enum`	Nom d'utilisateur, chemin d'accès et mot de passe requis.
`PATH_KEY`	`Enum`	Chemin et clé requis.
`KEY`	`Enum`	Clé ou jeton d'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 à cet élément `BigQueryConfig`.
`build()`	`Object`	Valide cet objet et le renvoie au format requis par Data Studio.
`printJson()`	`String`	Imprime la représentation JSON de cet objet.
`setAccessToken(accessToken)`	`BigQueryConfig`	Définit le jeton d'accès de cet élément `BigQueryConfig`.
`setBillingProjectId(billingProjectId)`	`BigQueryConfig`	Définit l'ID du projet de facturation de cet élément `BigQueryConfig`.
`setQuery(query)`	`BigQueryConfig`	Définit la requête SQL de cet élément `BigQueryConfig`.
`setUseStandardSql(useStandardSql)`	`BigQueryConfig`	Détermine si la requête est interprétée en SQL standard ou en ancien SQL.

`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`	Active le forçage pour 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 nouvel outil de création d'options.
`newSelectMultiple()`	`SelectMultiple`	Renvoie une nouvelle entrée de configuration de sélection multiple.
`newSelectSingle()`	`SelectSingle`	Renvoie une nouvelle entrée de configuration sélectionnée.
`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`	Imprime 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`	Imprime la représentation JSON de cet objet.
`setText(text)`	`DebugError`	Définit le texte de l'erreur de débogage, qui n'est visible que par les administrateurs.
`throwException()`	`void`	Déclenche l'exception.

`Field`

Méthodes

Méthode	Type renvoyé	Brève description
`getAggregation()`	`AggregationType`	Renvoie l'`AggregationType` de cet objet `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 l'`FieldType` de cet objet `Field`.
`isDefault()`	`Boolean`	Renvoie `true` si cette `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 cet élément `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 cette `Field`.
`setDescription(description)`	`Field`	Définit la description de cet élément `Field`.
`setFormula(formula)`	`Field`	Définit la formule de cet élément `Field`.
`setGroup(group)`	`Field`	Définit le groupe de cet élément `Field`.
`setId(id)`	`Field`	Définit l'ID de cet objet `Field`.
`setIsHidden(isHidden)`	`Field`	Définit l'état masqué de cet objet `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Définit l'état d'autorisation de la réagrégation 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 dans la plage [0,6], où 0 correspond à 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`	Pays (par exemple, États-Unis)
`COUNTRY_CODE`	`Enum`	Un code pays, par exemple "US".
`CONTINENT`	`Enum`	Un continent, comme les Amériques.
`CONTINENT_CODE`	`Enum`	Un code de continent, par exemple 019.
`SUB_CONTINENT`	`Enum`	Un sous-continent, comme l'Amérique du Nord.
`SUB_CONTINENT_CODE`	`Enum`	Code du sous-continent (par exemple, 003)
`REGION`	`Enum`	Région (par exemple, Californie)
`REGION_CODE`	`Enum`	Code de région, par exemple CA.
`CITY`	`Enum`	Une ville comme Mountain View.
`CITY_CODE`	`Enum`	Un code de ville, par exemple 1014044.
`METRO`	`Enum`	Un métro comme San Francisco-Oakland-San Jose CA
`METRO_CODE`	`Enum`	Un code d'agglomération, par exemple 200807.
`LATITUDE_LONGITUDE`	`Enum`	Une paire latitude/longitude, par exemple 51.5074, -0.1278.
`NUMBER`	`Enum`	Un nombre décimal.
`PERCENT`	`Enum`	Pourcentage décimal (peut être supérieur à 1,0).
`TEXT`	`Enum`	Texte libre.
`BOOLEAN`	`Enum`	Valeur booléenne `true` ou `false`.
`URL`	`Enum`	Une URL sous forme de texte, par exemple https://google.com.
`HYPERLINK`	`Enum`	Lien hypertexte.
`IMAGE`	`Enum`	Image.
`IMAGE_LINK`	`Enum`	Lien vers une image.
`CURRENCY_AED`	`Enum`	Devise de AED.
`CURRENCY_ALL`	`Enum`	Devise de TOUS.
`CURRENCY_ARS`	`Enum`	Devise de l'ARS.
`CURRENCY_AUD`	`Enum`	Devise de l'AUD.
`CURRENCY_BDT`	`Enum`	Devise de BDT.
`CURRENCY_BGN`	`Enum`	Devise en BGN.
`CURRENCY_BOB`	`Enum`	Devise de BOB.
`CURRENCY_BRL`	`Enum`	Devise du réal brésilien.
`CURRENCY_CAD`	`Enum`	Devise du CAD.
`CURRENCY_CDF`	`Enum`	Devise de la CDF.
`CURRENCY_CHF`	`Enum`	Devise de CHF.
`CURRENCY_CLP`	`Enum`	Devise CLP.
`CURRENCY_CNY`	`Enum`	Devise de CNY.
`CURRENCY_COP`	`Enum`	Devise du COP.
`CURRENCY_CRC`	`Enum`	Devise du CRC
`CURRENCY_CZK`	`Enum`	Devise de CZK.
`CURRENCY_DKK`	`Enum`	Devise DKK.
`CURRENCY_DOP`	`Enum`	Devise de l'opérateur
`CURRENCY_EGP`	`Enum`	Devise de l'EGP.
`CURRENCY_ETB`	`Enum`	Devise de l'ETB.
`CURRENCY_EUR`	`Enum`	Devise de l'EUR.
`CURRENCY_GBP`	`Enum`	Devise de GBP.
`CURRENCY_HKD`	`Enum`	Devise HKD.
`CURRENCY_HRK`	`Enum`	Devise HRK.
`CURRENCY_HUF`	`Enum`	Devise HUF.
`CURRENCY_IDR`	`Enum`	Devise IDR.
`CURRENCY_ILS`	`Enum`	Devise de l'ILS.
`CURRENCY_INR`	`Enum`	Devise de l'INR.
`CURRENCY_IRR`	`Enum`	Devise de l'IRR.
`CURRENCY_ISK`	`Enum`	Devise de l'ISK.
`CURRENCY_JMD`	`Enum`	Devise de JMD.
`CURRENCY_JPY`	`Enum`	Devise JPY.
`CURRENCY_KRW`	`Enum`	Devise KRW.
`CURRENCY_LKR`	`Enum`	Devise de LKR.
`CURRENCY_LTL`	`Enum`	Devise de LTL.
`CURRENCY_MNT`	`Enum`	Devise de MNT.
`CURRENCY_MVR`	`Enum`	Devise de 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 de 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 de RSD.
`CURRENCY_RUB`	`Enum`	Devise RUB.
`CURRENCY_SAR`	`Enum`	Devise du SAR.
`CURRENCY_SEK`	`Enum`	Devise SEK.
`CURRENCY_SGD`	`Enum`	Devise SGD.
`CURRENCY_THB`	`Enum`	Devise THB.
`CURRENCY_TRY`	`Enum`	Devise de TRY.
`CURRENCY_TWD`	`Enum`	Devise TWD.
`CURRENCY_TZS`	`Enum`	Devise de TZS.
`CURRENCY_UAH`	`Enum`	Devise UAH.
`CURRENCY_USD`	`Enum`	Devise à partir du dollar américain.
`CURRENCY_UYU`	`Enum`	Devise de l'UYU.
`CURRENCY_VEF`	`Enum`	Devise de VEF.
`CURRENCY_VND`	`Enum`	Devise de VND.
`CURRENCY_YER`	`Enum`	Devise de YER.
`CURRENCY_ZAR`	`Enum`	Devise de ZAR.

`Fields`

Méthodes

Méthode	Type renvoyé	Brève description
`asArray()`	`Field[]`	Affiche 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é pour les `Field` avec un ID dans `ids`.
`getDefaultDimension()`	`Field`	Renvoie la dimension par défaut à utiliser pour l'ensemble de champs.
`getDefaultMetric()`	`Field`	Renvoie la métrique par défaut à utiliser pour l'ensemble de 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`	Imprime 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 à cette `GetDataResponse`.
`addRow(row)`	`GetDataResponse`	Ajoute une ligne de données à cet élément `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 cet outil de création.

`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`	Imprime 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 nouvelle option de sélection.
`setAllowOverride(allowOverride)`	`SelectMultiple`	Active le forçage pour 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 nouvelle option de sélection.
`setAllowOverride(allowOverride)`	`SelectSingle`	Active le forçage pour 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`	Imprime 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`	Active le forçage pour 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`	Active le forçage pour 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`	Imprime la représentation JSON de cet objet.
`setDebugText(text)`	`UserError`	Définit le texte de l'erreur de débogage, qui n'est visible que par les administrateurs.
`setText(text)`	`UserError`	Définit le texte de l'erreur utilisateur.
`throwException()`	`void`	Déclenche l'exception.