Esta página foi traduzida pela API Cloud Translation.

Data Studio Service

Esse serviço permite que os scripts acessem e modifiquem os Conectores da comunidade do Data Studio.

Classes

Nome	Breve descrição
`AggregationType`	Um tipo enumerado que define os tipos de agregação que podem ser definidos para um `Field`.
`AuthType`	Um tipo enumerado que define os tipos de autenticação que podem ser definidos para um conector.
`BigQueryConfig`	Um objeto de configuração para um conector nativo do BigQuery.
`BigQueryParameterType`	Um tipo enumerado que define os tipos de parâmetro do BigQuery que podem ser definidos.
`Checkbox`	Contém informações de caixa de seleção para a configuração.
`CommunityConnector`	O conectorda comunidade permite que scripts acessem builders e utilitários para ajudar no desenvolvimento de conectores da comunidade para o Data Studio.
`Config`	Contém as entradas de configuração de um conector.
`DataStudioApp`	O aplicativo DataStudio permite que scripts interajam com recursos voltados a desenvolvedores do Data Studio.
`DebugError`	Um erro que só é visível para os administradores do conector.
`Field`	Contém dados relacionados ao campo.
`FieldType`	Um tipo enumerado que define os tipos que podem ser definidos para um `Field`.
`Fields`	Contém um conjunto de `Field`s para um conector da comunidade.
`GetAuthTypeResponse`	Builder para criar uma resposta `getAuthType()` para o projeto do script.
`GetDataResponse`	Builder para criar uma resposta `getData()` para o projeto do script.
`GetSchemaResponse`	Builder para criar uma resposta `getSchema()` para o projeto do script.
`Info`	Contém dados de informações para a configuração.
`OptionBuilder`	Um builder para criar opções para `SelectSingle`s e `SelectMultiple`s.
`SelectMultiple`	Contém várias informações selecionadas para a configuração.
`SelectSingle`	Contém informações únicas selecionadas para a configuração.
`SetCredentialsResponse`	Builder para criar uma resposta `setCredentials()` para o projeto do script.
`TextArea`	Contém informações da área de texto para a configuração.
`TextInput`	Contém informações de entrada de texto para a configuração.
`UserError`	Um erro que aparece para os usuários do conector.

`AggregationType`

Propriedades

Propriedade	Tipo	Descrição
`AVG`	`Enum`	Média.
`COUNT`	`Enum`	Contagem.
`COUNT_DISTINCT`	`Enum`	Count Distinct.
`MAX`	`Enum`	Máx.
`MIN`	`Enum`	Mín.
`SUM`	`Enum`	Soma.
`AUTO`	`Enum`	Automático.

`AuthType`

Propriedades

Propriedade	Tipo	Descrição
`NONE`	`Enum`	Não é necessária autorização.
`OAUTH2`	`Enum`	Autorização OAuth2 necessária.
`USER_PASS`	`Enum`	É necessário ter credenciais de nome de usuário e senha.
`PATH_USER_PASS`	`Enum`	Nome de usuário, caminho e senha necessários.
`PATH_KEY`	`Enum`	Caminho e chave necessários.
`KEY`	`Enum`	É necessário ter uma chave ou um token da API.
`USER_TOKEN`	`Enum`	Nome de usuário e token necessários.

`BigQueryConfig`

Métodos

Método	Tipo de retorno	Breve descrição
`addQueryParameter(name, type, value)`	`BigQueryConfig`	Adiciona um parâmetro de consulta a `BigQueryConfig`.
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setAccessToken(accessToken)`	`BigQueryConfig`	Define o token de acesso desse `BigQueryConfig`.
`setBillingProjectId(billingProjectId)`	`BigQueryConfig`	Define o ID do projeto de faturamento desse `BigQueryConfig`.
`setQuery(query)`	`BigQueryConfig`	Define a consulta SQL desse `BigQueryConfig`.
`setUseStandardSql(useStandardSql)`	`BigQueryConfig`	Determina se a consulta é interpretada como SQL padrão ou legado.

`BigQueryParameterType`

Propriedades

Propriedade	Tipo	Descrição
`STRING`	`Enum`	String.
`INT64`	`Enum`	Inteiro de 64-bit.
`BOOL`	`Enum`	Booleano.
`FLOAT64`	`Enum`	Número de ponto flutuante de 64 bits.

`Checkbox`

Métodos

Método	Tipo de retorno	Breve descrição
`setAllowOverride(allowOverride)`	`Checkbox`	Permite substituir esta entrada de configuração.
`setHelpText(helpText)`	`Checkbox`	Define o texto de ajuda para essa entrada de configuração.
`setId(id)`	`Checkbox`	Define o ID exclusivo para essa entrada de configuração.
`setIsDynamic(isDynamic)`	`Checkbox`	Define o status dinâmico para esta entrada de configuração.
`setName(name)`	`Checkbox`	Define o nome de exibição para essa entrada de configuração.

`CommunityConnector`

Propriedades

Propriedade	Tipo	Descrição
`AggregationType`	`AggregationType`	A enumeração `AggregationType`.
`AuthType`	`AuthType`	A enumeração `AuthType`.
`BigQueryParameterType`	`BigQueryParameterType`	A enumeração `BigQueryParameterType`.
`FieldType`	`FieldType`	A enumeração `FieldType`.

Métodos

Método	Tipo de retorno	Breve descrição
`getConfig()`	`Config`	Retorna um objeto `Config`.
`getFields()`	`Fields`	Retorna um objeto `Fields`.
`newAuthTypeResponse()`	`GetAuthTypeResponse`	Retorna um novo objeto `GetAuthTypeResponse`.
`newBigQueryConfig()`	`BigQueryConfig`	Retorna um novo objeto `BigQueryConfig`.
`newDebugError()`	`DebugError`	Retorna um novo objeto `DebugError`.
`newGetDataResponse()`	`GetDataResponse`	Retorna um novo objeto `GetDataResponse`.
`newGetSchemaResponse()`	`GetSchemaResponse`	Retorna um novo objeto `GetSchemaResponse`.
`newSetCredentialsResponse()`	`SetCredentialsResponse`	Retorna um novo objeto `SetCredentialsResponse`.
`newUserError()`	`UserError`	Retorna um novo objeto `UserError`.

`Config`

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`newCheckbox()`	`Checkbox`	Retorna uma nova entrada de configuração de caixa de seleção.
`newInfo()`	`Info`	Retorna uma nova entrada de configuração de informações.
`newOptionBuilder()`	`OptionBuilder`	Retorna um novo builder de opções.
`newSelectMultiple()`	`SelectMultiple`	Retorna uma nova entrada de seleção de várias configurações.
`newSelectSingle()`	`SelectSingle`	Retorna uma nova entrada de configuração única selecionada.
`newTextArea()`	`TextArea`	Retorna uma nova entrada de configuração da área de texto.
`newTextInput()`	`TextInput`	Retorna uma nova entrada de configuração de entrada de texto.
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setDateRangeRequired(dateRangeRequired)`	`Config`	Se `true`, um período será fornecido para solicitações getData().
`setIsSteppedConfig(isSteppedConfig)`	`Config`	Se `true`, `getConfig()` é chamado novamente com a configuração atual do usuário.

`DataStudioApp`

Métodos

Método	Tipo de retorno	Breve descrição
`createCommunityConnector()`	`CommunityConnector`	Cria um novo conector da comunidade.

`DebugError`

Métodos

Método	Tipo de retorno	Breve descrição
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setText(text)`	`DebugError`	Define o texto do erro de depuração, que só é mostrado para administradores.
`throwException()`	`void`	Aciona essa exceção.

`Field`

Métodos

Método	Tipo de retorno	Breve descrição
`getAggregation()`	`AggregationType`	Retorna o `AggregationType` desse `Field`.
`getDescription()`	`String`	Retorna a descrição desse `Field`.
`getFormula()`	`String`	Retorna a fórmula desse `Field`.
`getGroup()`	`String`	Retorna o grupo dessa `Field`.
`getId()`	`String`	Retorna o ID dessa `Field`.
`getIsReaggregatable()`	`Boolean`	Retorna `true` se esse campo puder ser reagrupado. Caso contrário, retorna `false`.
`getName()`	`String`	Retorna o nome deste `Field`.
`getType()`	`FieldType`	Retorna o `FieldType` desse `Field`.
`isDefault()`	`Boolean`	Retorna `true` se `Field` for a métrica ou dimensão padrão.
`isDimension()`	`Boolean`	Retorna `true` se esse campo for uma dimensão.
`isHidden()`	`Boolean`	Retorna `true` se `Field` estiver oculto.
`isMetric()`	`Boolean`	Retorna `true` se esse campo for uma métrica.
`setAggregation(aggregation)`	`Field`	Define o tipo de agregação desse `Field`.
`setDescription(description)`	`Field`	Define a descrição desse `Field`.
`setFormula(formula)`	`Field`	Define a fórmula desse `Field`.
`setGroup(group)`	`Field`	Define o grupo dessa `Field`.
`setId(id)`	`Field`	Define o ID desse `Field`.
`setIsHidden(isHidden)`	`Field`	Define o status oculto desta `Field`.
`setIsReaggregatable(isReaggregatable)`	`Field`	Define o status permitido para reagregação de um `Field`.
`setName(name)`	`Field`	Define o nome deste `Field`.
`setType(type)`	`Field`	Define o `FieldType` deste `Field`.

`FieldType`

Propriedades

Propriedade	Tipo	Descrição
`YEAR`	`Enum`	Ano no formato AAAA, como 2017.
`YEAR_QUARTER`	`Enum`	Ano e trimestre no formato AAAAT, como 20171.
`YEAR_MONTH`	`Enum`	Ano e mês no formato AAAAMM, como 201703.
`YEAR_WEEK`	`Enum`	Ano e semana no formato AAAAww, como 201707.
`YEAR_MONTH_DAY`	`Enum`	Ano, mês e dia no formato AAAAMMDD, por exemplo, 20170317.
`YEAR_MONTH_DAY_HOUR`	`Enum`	Ano, mês, dia e hora no formato AAAAMMDDHH, como 2017031703.
`YEAR_MONTH_DAY_MINUTE`	`Enum`	Ano, mês, dia, hora e minuto no formato AAAAMMDDHHmm, como 201703170230.
`YEAR_MONTH_DAY_SECOND`	`Enum`	Ano, mês, dia, hora, minuto e segundo no formato AAAAMMDDHHmmss, por exemplo, 20170317023017.
`QUARTER`	`Enum`	Trimestre no formato 1, 2, 3 ou 4.
`MONTH`	`Enum`	Mês no formato MM, como 03.
`WEEK`	`Enum`	Semana no formato de ww, como 07.
`MONTH_DAY`	`Enum`	Mês e dia no formato AAAA-MM-DD, como 0317.
`DAY_OF_WEEK`	`Enum`	Um número no intervalo [0,6], em que 0 representa domingo.
`DAY`	`Enum`	Dia no formato DD, como 17.
`HOUR`	`Enum`	Hora no formato HH, como 13.
`MINUTE`	`Enum`	Minuto no formato mm, por exemplo, 12.
`DURATION`	`Enum`	Uma duração em segundos.
`COUNTRY`	`Enum`	Um país, como os Estados Unidos.
`COUNTRY_CODE`	`Enum`	Um código de país, como "US".
`CONTINENT`	`Enum`	Um continente, como as Américas.
`CONTINENT_CODE`	`Enum`	Um código de continente, como 019.
`SUB_CONTINENT`	`Enum`	Um subcontinente, como a América do Norte.
`SUB_CONTINENT_CODE`	`Enum`	Um código de subcontinente, como 003.
`REGION`	`Enum`	Uma região, como a Califórnia.
`REGION_CODE`	`Enum`	Um código de região, como "CA".
`CITY`	`Enum`	Uma cidade, como Mountain View.
`CITY_CODE`	`Enum`	Um código de cidade, como 1014044.
`METRO`	`Enum`	Um metrô, como San Francisco-Oakland-San Jose CA.
`METRO_CODE`	`Enum`	Um código de área metropolitana, como 200807.
`LATITUDE_LONGITUDE`	`Enum`	Um par de latitude e longitude, como 51.5074, -0.1278.
`NUMBER`	`Enum`	Um número decimal.
`PERCENT`	`Enum`	Percentual decimal (pode ser superior a 1,0).
`TEXT`	`Enum`	Texto de forma livre.
`BOOLEAN`	`Enum`	Um valor booleano `true` ou `false`.
`URL`	`Enum`	Um URL como texto, por exemplo, https://google.com.
`HYPERLINK`	`Enum`	Um hiperlink.
`IMAGE`	`Enum`	Uma imagem.
`IMAGE_LINK`	`Enum`	Um link de imagem.
`CURRENCY_AED`	`Enum`	Moeda de AED.
`CURRENCY_ALL`	`Enum`	Moeda de TODOS.
`CURRENCY_ARS`	`Enum`	Moeda de ARS.
`CURRENCY_AUD`	`Enum`	Moeda de AUD.
`CURRENCY_BDT`	`Enum`	Moeda do BDT.
`CURRENCY_BGN`	`Enum`	Moeda de BGN.
`CURRENCY_BOB`	`Enum`	Moeda do BOB.
`CURRENCY_BRL`	`Enum`	Moeda de BRL.
`CURRENCY_CAD`	`Enum`	Moeda em CAD.
`CURRENCY_CDF`	`Enum`	Moeda do CDF.
`CURRENCY_CHF`	`Enum`	Moeda de CHF.
`CURRENCY_CLP`	`Enum`	Moeda de CLP.
`CURRENCY_CNY`	`Enum`	Moeda de CNY.
`CURRENCY_COP`	`Enum`	Moeda de COP.
`CURRENCY_CRC`	`Enum`	Moeda do CRC.
`CURRENCY_CZK`	`Enum`	Moeda de CZK.
`CURRENCY_DKK`	`Enum`	Moeda de DKK.
`CURRENCY_DOP`	`Enum`	Moeda de DOP.
`CURRENCY_EGP`	`Enum`	Moeda do EGP.
`CURRENCY_ETB`	`Enum`	Moeda do ETB.
`CURRENCY_EUR`	`Enum`	Moeda de EUR.
`CURRENCY_GBP`	`Enum`	Moeda de GBP.
`CURRENCY_HKD`	`Enum`	Moeda de HKD.
`CURRENCY_HRK`	`Enum`	Moeda de HRK.
`CURRENCY_HUF`	`Enum`	Moeda de HUF.
`CURRENCY_IDR`	`Enum`	Moeda de IDR.
`CURRENCY_ILS`	`Enum`	Moeda de ILS.
`CURRENCY_INR`	`Enum`	Moeda de INR.
`CURRENCY_IRR`	`Enum`	Moeda do IRR.
`CURRENCY_ISK`	`Enum`	Moeda de ISK.
`CURRENCY_JMD`	`Enum`	Moeda de JMD.
`CURRENCY_JPY`	`Enum`	Moeda de JPY.
`CURRENCY_KRW`	`Enum`	Moeda de KRW.
`CURRENCY_LKR`	`Enum`	Moeda de LKR.
`CURRENCY_LTL`	`Enum`	Moeda de LTL.
`CURRENCY_MNT`	`Enum`	Moeda de MNT.
`CURRENCY_MVR`	`Enum`	Moeda da MVR.
`CURRENCY_MXN`	`Enum`	Moeda de MXN.
`CURRENCY_MYR`	`Enum`	Moeda de MYR.
`CURRENCY_NGN`	`Enum`	Moeda de NGN.
`CURRENCY_NOK`	`Enum`	Moeda de NOK.
`CURRENCY_NZD`	`Enum`	Moeda de NZD.
`CURRENCY_PAB`	`Enum`	Moeda de PAB.
`CURRENCY_PEN`	`Enum`	Moeda de PEN.
`CURRENCY_PHP`	`Enum`	Moeda do PHP.
`CURRENCY_PKR`	`Enum`	Moeda de PKR.
`CURRENCY_PLN`	`Enum`	Moeda de PLN.
`CURRENCY_RON`	`Enum`	Moeda de RON.
`CURRENCY_RSD`	`Enum`	Moeda de RSD.
`CURRENCY_RUB`	`Enum`	Moeda de RUB.
`CURRENCY_SAR`	`Enum`	Moeda da Arábia Saudita.
`CURRENCY_SEK`	`Enum`	Moeda de SEK.
`CURRENCY_SGD`	`Enum`	Moeda de SGD.
`CURRENCY_THB`	`Enum`	Moeda de THB.
`CURRENCY_TRY`	`Enum`	Moeda de TRY.
`CURRENCY_TWD`	`Enum`	Moeda de TWD.
`CURRENCY_TZS`	`Enum`	Moeda de TZS.
`CURRENCY_UAH`	`Enum`	Moeda de UAH.
`CURRENCY_USD`	`Enum`	Moeda em USD.
`CURRENCY_UYU`	`Enum`	Moeda de UYU.
`CURRENCY_VEF`	`Enum`	Moeda do VEF.
`CURRENCY_VND`	`Enum`	Moeda de VND.
`CURRENCY_YER`	`Enum`	Moeda de YER.
`CURRENCY_ZAR`	`Enum`	Moeda de ZAR.

`Fields`

Métodos

Método	Tipo de retorno	Breve descrição
`asArray()`	`Field[]`	Retorna uma visualização desse objeto como uma matriz.
`build()`	`Object[]`	Valida e retorna o objeto no formato necessário para o Data Studio.
`forIds(ids)`	`Fields`	Retorna um novo objeto `Fields` filtrado para `Field`s com um ID em `ids`.
`getDefaultDimension()`	`Field`	Retorna a dimensão padrão a ser usada para o conjunto de campos.
`getDefaultMetric()`	`Field`	Retorna a métrica padrão a ser usada para o conjunto de campos.
`getFieldById(fieldId)`	`Field`	Retorna um campo com um determinado ID ou `null` se nenhum campo com esse ID estiver neste objeto `Fields`.
`newDimension()`	`Field`	Retorna uma nova dimensão `Field`.
`newMetric()`	`Field`	Retorna uma nova métrica `Field`.
`setDefaultDimension(fieldId)`	`void`	Define a dimensão padrão a ser usada para o conjunto de campos.
`setDefaultMetric(fieldId)`	`void`	Define a métrica padrão a ser usada para o conjunto de campos.

`GetAuthTypeResponse`

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setAuthType(authType)`	`GetAuthTypeResponse`	Define o `AuthType` do builder.
`setHelpUrl(helpUrl)`	`GetAuthTypeResponse`	Define o URL de ajuda do builder.

`GetDataResponse`

Métodos

Método	Tipo de retorno	Breve descrição
`addAllRows(rows)`	`GetDataResponse`	Adiciona várias linhas de dados a este `GetDataResponse`.
`addRow(row)`	`GetDataResponse`	Adiciona uma linha de dados a `GetDataResponse`.
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`setFields(fields)`	`GetDataResponse`	Define o `Fields` do builder.
`setFiltersApplied(filtersApplied)`	`GetDataResponse`	Define o status dos filtros aplicados para esse criador.

`GetSchemaResponse`

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setFields(fields)`	`GetSchemaResponse`	Define o `Fields` do builder.

`Info`

Métodos

Método	Tipo de retorno	Breve descrição
`setId(id)`	`Info`	Define o ID exclusivo para essa entrada de configuração.
`setText(text)`	`Info`	Define o texto para esta entrada de configuração.

`OptionBuilder`

Métodos

Método	Tipo de retorno	Breve descrição
`setLabel(label)`	`OptionBuilder`	Define o rótulo desse builder de opções.
`setValue(value)`	`OptionBuilder`	Define o valor desse builder de opções.

`SelectMultiple`

Métodos

Método	Tipo de retorno	Breve descrição
`addOption(optionBuilder)`	`SelectMultiple`	Adiciona uma nova opção de seleção.
`setAllowOverride(allowOverride)`	`SelectMultiple`	Permite substituir esta entrada de configuração.
`setHelpText(helpText)`	`SelectMultiple`	Define o texto de ajuda para essa entrada de configuração.
`setId(id)`	`SelectMultiple`	Define o ID exclusivo para essa entrada de configuração.
`setIsDynamic(isDynamic)`	`SelectMultiple`	Define o status dinâmico para esta entrada de configuração.
`setName(name)`	`SelectMultiple`	Define o nome de exibição para essa entrada de configuração.

`SelectSingle`

Métodos

Método	Tipo de retorno	Breve descrição
`addOption(optionBuilder)`	`SelectSingle`	Adiciona uma nova opção de seleção.
`setAllowOverride(allowOverride)`	`SelectSingle`	Permite substituir esta entrada de configuração.
`setHelpText(helpText)`	`SelectSingle`	Define o texto de ajuda para essa entrada de configuração.
`setId(id)`	`SelectSingle`	Define o ID exclusivo para essa entrada de configuração.
`setIsDynamic(isDynamic)`	`SelectSingle`	Define o status dinâmico para esta entrada de configuração.
`setName(name)`	`SelectSingle`	Define o nome de exibição para essa entrada de configuração.

`SetCredentialsResponse`

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`Object`	Valida e retorna o objeto no formato necessário para o Data Studio.
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setIsValid(isValid)`	`SetCredentialsResponse`	Define o status válido deste `SetCredentialsResponse`.

`TextArea`

Métodos

Método	Tipo de retorno	Breve descrição
`setAllowOverride(allowOverride)`	`TextArea`	Permite substituir esta entrada de configuração.
`setHelpText(helpText)`	`TextArea`	Define o texto de ajuda para essa entrada de configuração.
`setId(id)`	`TextArea`	Define o ID exclusivo para essa entrada de configuração.
`setIsDynamic(isDynamic)`	`TextArea`	Define o status dinâmico para esta entrada de configuração.
`setName(name)`	`TextArea`	Define o nome de exibição para essa entrada de configuração.
`setPlaceholder(placeholder)`	`TextArea`	Define o texto do marcador de posição para esta entrada de configuração.

`TextInput`

Métodos

Método	Tipo de retorno	Breve descrição
`setAllowOverride(allowOverride)`	`TextInput`	Permite substituir esta entrada de configuração.
`setHelpText(helpText)`	`TextInput`	Define o texto de ajuda para essa entrada de configuração.
`setId(id)`	`TextInput`	Define o ID exclusivo para essa entrada de configuração.
`setIsDynamic(isDynamic)`	`TextInput`	Define o status dinâmico para esta entrada de configuração.
`setName(name)`	`TextInput`	Define o nome de exibição para essa entrada de configuração.
`setPlaceholder(placeholder)`	`TextInput`	Define o texto do marcador de posição para esta entrada de configuração.

`UserError`

Métodos

Método	Tipo de retorno	Breve descrição
`printJson()`	`String`	Mostra a representação JSON desse objeto.
`setDebugText(text)`	`UserError`	Define o texto do erro de depuração, que só é mostrado para administradores.
`setText(text)`	`UserError`	Define o texto do erro do usuário.
`throwException()`	`void`	Aciona essa exceção.