Ce service permet aux scripts d'accéder aux connecteurs de 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 une Field . |
AuthType | Énumération définissant 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 la case à cocher pour la configuration. |
CommunityConnector | CommunityConnector permet aux scripts d'accéder à des compilateurs et à des utilitaires qui facilitent 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 des données d'informations pour la configuration. |
OptionBuilder | Compilateur permettant de créer des options pour les SelectSingle et les SelectMultiple . |
SelectMultiple | Contient la sélection de plusieurs informations pour la configuration. |
SelectSingle | Contient une seule information sélectionnée pour 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 d'entrée de texte pour la configuration. |
UserError | Erreur présentée aux utilisateurs du connecteur. |
AggregationType
Propriétés
Propriété | Type | Description |
---|---|---|
AVG | Enum | Moyenne. |
COUNT | Enum | Décompte. |
COUNT_DISTINCT | Enum | Valeurs distinctes. |
MAX | Enum | CPC |
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 | 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 d'accès et clé requis. |
KEY | Enum | Clé API ou jeton 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 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'identifiant 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 des informations. |
newOptionBuilder() | OptionBuilder | Renvoie un nouveau compilateur d'options. |
newSelectMultiple() | SelectMultiple | Renvoie une nouvelle entrée de configuration "select multiple". |
newSelectSingle() | SelectSingle | Renvoie une nouvelle entrée de configuration "select 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 la valeur est 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 ne s'affiche que pour les administrateurs. |
throwException() | void | Déclenche cette exception. |
Field
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getAggregation() | AggregationType | Renvoie le AggregationType de ce Field . |
getDescription() | String | Renvoie la description de ce Field . |
getFormula() | String | Renvoie la formule de ce Field . |
getGroup() | String | Renvoie le groupe de ce Field . |
getId() | String | Renvoie l'ID de ce Field . |
getIsReaggregatable() | Boolean | Renvoie la valeur true si ce champ peut être réagrégé, et la valeur false dans le cas contraire. |
getName() | String | Renvoie le nom de cet objet Field . |
getType() | FieldType | Renvoie le FieldType de ce Field . |
isDefault() | Boolean | Renvoie true si Field est la métrique ou la dimension par défaut. |
isDimension() | Boolean | Renvoie la valeur true si ce champ est une dimension. |
isHidden() | Boolean | Renvoie la valeur 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 cet élément 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 ce Field . |
setId(id) | Field | Définit l'ID de cet élément Field . |
setIsHidden(isHidden) | Field | Définit l'état masqué de ce Field . |
setIsReaggregatable(isReaggregatable) | Field | Définit l'état d'autorisation de réagrégation pour une Field . |
setName(name) | Field | Définit le nom de ce Field . |
setType(type) | Field | Définit l'élément FieldType de cet élément 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 AAAAQ, tel que 20171. |
YEAR_MONTH | Enum | Année et mois au format AAAAMM (par exemple, 201703). |
YEAR_WEEK | Enum | Année et semaine au format AAAAss (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 | le trimestre au format 1, 2, 3 ou 4). |
MONTH | Enum | Mois au format MM tel que 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,6], 0 représentant dimanche. |
DAY | Enum | Jour au format JJ, tel que 17. |
HOUR | Enum | Heure au format HH (13, par exemple). |
MINUTE | Enum | Minutes au format mm (par exemple, 12). |
DURATION | Enum | Durée, en secondes. |
COUNTRY | Enum | Pays tel que les États-Unis. |
COUNTRY_CODE | Enum | Un code pays, tel que US. |
CONTINENT | Enum | Un continent tel que le continent américain. |
CONTINENT_CODE | Enum | Un code de continent, tel que 019. |
SUB_CONTINENT | Enum | Sous-continent tel que l'Amérique du Nord. |
SUB_CONTINENT_CODE | Enum | Un code de sous-continent, tel que 003. |
REGION | Enum | Une région telle que la Californie. |
REGION_CODE | Enum | Un code régional, tel que CA. |
CITY | Enum | une ville telle que Mountain View ; |
CITY_CODE | Enum | Un code de ville, par exemple 1014044 |
METRO | Enum | Agglomération comme San Francisco-Oakland-San Jose, Californie. |
METRO_CODE | Enum | Code d'agglomération tel que 200807 |
LATITUDE_LONGITUDE | Enum | Paire latitude/longitude telle que 51.5074, -0.1278. |
NUMBER | Enum | Nombre décimal. |
PERCENT | Enum | Pourcentage décimal (peut être supérieur à 1). |
TEXT | Enum | Texte au format libre. |
BOOLEAN | Enum | Une valeur booléenne true ou false . |
URL | Enum | URL sous forme de texte telle que https://google.com. |
HYPERLINK | Enum | Un lien hypertexte. |
IMAGE | Enum | Image. |
IMAGE_LINK | Enum | Lien image. |
CURRENCY_AED | Enum | Devise de l'AED. |
CURRENCY_ALL | Enum | Devise : ALL. |
CURRENCY_ARS | Enum | Devise de l'ARS. |
CURRENCY_AUD | Enum | Devise : AUD. |
CURRENCY_BDT | Enum | Devise du BDT. |
CURRENCY_BGN | Enum | Devise : BGN. |
CURRENCY_BOB | Enum | Devise de la devise BOB. |
CURRENCY_BRL | Enum | Devise : BRL. |
CURRENCY_CAD | Enum | Devise : CAD. |
CURRENCY_CDF | Enum | Devise de la CDF. |
CURRENCY_CHF | Enum | Devise en CHF. |
CURRENCY_CLP | Enum | Devise de la peso chilien. |
CURRENCY_CNY | Enum | Devise : CNY. |
CURRENCY_COP | Enum | Devise du COP. |
CURRENCY_CRC | Enum | Devise du CRC. |
CURRENCY_CZK | Enum | Devise : CZK. |
CURRENCY_DKK | Enum | Devise de la devise DKK. |
CURRENCY_DOP | Enum | Devise du DOP. |
CURRENCY_EGP | Enum | Devise du EGP. |
CURRENCY_ETB | Enum | Devise de l'ETB. |
CURRENCY_EUR | Enum | Devise : EUR. |
CURRENCY_GBP | Enum | Devise de la devise GBP. |
CURRENCY_HKD | Enum | Devise de la devise HKD. |
CURRENCY_HRK | Enum | Devise de la kuna (HRK). |
CURRENCY_HUF | Enum | Devise en HUF. |
CURRENCY_IDR | Enum | Devise exprimée en 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 la devise JMD. |
CURRENCY_JPY | Enum | Devise : JPY. |
CURRENCY_KRW | Enum | Devise : KRW. |
CURRENCY_LKR | Enum | Devise de la devise LKR. |
CURRENCY_LTL | Enum | Devise de LTL. |
CURRENCY_MNT | Enum | Devise de MNT. |
CURRENCY_MVR | Enum | Devise du MVR. |
CURRENCY_MXN | Enum | Devise : MXN. |
CURRENCY_MYR | Enum | Devise : MYR. |
CURRENCY_NGN | Enum | Devise du NGN. |
CURRENCY_NOK | Enum | Devise : NOK. |
CURRENCY_NZD | Enum | Devise de : NZD. |
CURRENCY_PAB | Enum | Devise du PAB. |
CURRENCY_PEN | Enum | Devise : PEN. |
CURRENCY_PHP | Enum | Devise : PHP. |
CURRENCY_PKR | Enum | Devise : PKR. |
CURRENCY_PLN | Enum | Devise : PLN. |
CURRENCY_RON | Enum | Devise : RON. |
CURRENCY_RSD | Enum | Devise de la devise RSD. |
CURRENCY_RUB | Enum | Devise du RUB. |
CURRENCY_SAR | Enum | Devise du SAR. |
CURRENCY_SEK | Enum | Devise de la devise SEK. |
CURRENCY_SGD | Enum | Devise : SGD. |
CURRENCY_THB | Enum | Devise : THB. |
CURRENCY_TRY | Enum | Devise : TRY. |
CURRENCY_TWD | Enum | Devise : TWD. |
CURRENCY_TZS | Enum | Devise : TZS. |
CURRENCY_UAH | Enum | Devise de l'UAH. |
CURRENCY_USD | Enum | Devise : USD. |
CURRENCY_UYU | Enum | Devise de l'UYU. |
CURRENCY_VEF | Enum | Devise du 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 Field avec un ID 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 cet objet Fields ne contient aucun champ avec cet ID. |
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 des 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 les 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 les Fields du compilateur. |
setFiltersApplied(filtersApplied) | GetDataResponse | Définit l'état d'application des filtres pour ce compilateur. |
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 les Fields du compilateur. |
Info
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
setId(id) | Info | Définit l'identifiant 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'identifiant 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'identifiant 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 ce 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'identifiant 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'identifiant 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 ne s'affiche que pour les administrateurs. |
setText(text) | UserError | Définit le texte de l'erreur utilisateur. |
throwException() | void | Déclenche cette exception. |