Data Studio Service

Data Studio

Layanan ini memungkinkan skrip mengakses dan memodifikasi Konektor Komunitas Data Studio.

Class

NamaDeskripsi singkat
AggregationTypeEnum yang menentukan jenis agregasi yang dapat ditetapkan untuk Field.
AuthTypeEnum yang menentukan jenis autentikasi yang dapat ditetapkan untuk konektor.
BigQueryConfigObjek konfigurasi untuk konektor BigQuery native.
BigQueryParameterTypeEnum yang menentukan jenis parameter BigQuery yang dapat Anda tetapkan.
CheckboxBerisi informasi kotak centang untuk konfigurasi.
CommunityConnectorCommunityConnector memungkinkan skrip mengakses builder dan utilitas guna membantu pengembangan Konektor Komunitas untuk Data Studio.
ConfigBerisi entri konfigurasi untuk konektor.
DataStudioAppDataStudioApp memungkinkan skrip berinteraksi dengan fitur yang berorientasi developer untuk Data Studio.
DebugErrorError yang hanya dapat dilihat oleh admin konektor.
FieldBerisi data terkait kolom.
FieldTypeEnum yang menentukan jenis yang dapat ditetapkan untuk Field.
FieldsBerisi kumpulan Field untuk konektor komunitas.
GetAuthTypeResponseBuilder untuk membuat respons getAuthType() bagi project skrip Anda.
GetDataResponseBuilder untuk membuat respons getData() bagi project skrip Anda.
GetSchemaResponseBuilder untuk membuat respons getSchema() bagi project skrip Anda.
InfoBerisi data info untuk konfigurasi.
OptionBuilderBuilder untuk membuat opsi bagi SelectSingle dan SelectMultiple.
SelectMultipleBerisi beberapa informasi pemilihan untuk konfigurasi.
SelectSingleBerisi informasi tunggal tertentu untuk konfigurasi.
SetCredentialsResponseBuilder untuk membuat respons setCredentials() bagi project skrip Anda.
TextAreaBerisi informasi area teks untuk konfigurasi.
TextInputBerisi informasi input teks untuk konfigurasi.
UserErrorError yang ditampilkan kepada pengguna konektor.

AggregationType

Properti

PropertiJenisDeskripsi
AVGEnumRata-rata.
COUNTEnumJumlah.
COUNT_DISTINCTEnumJumlah Berbeda.
MAXEnumMaks.
MINEnumMin.
SUMEnumJumlah.
AUTOEnumOtomatis.

AuthType

Properti

PropertiJenisDeskripsi
NONEEnumTidak perlu otorisasi.
OAUTH2EnumDiperlukan otorisasi OAuth2.
USER_PASSEnumKredensial nama pengguna dan sandi diperlukan.
PATH_USER_PASSEnumNama pengguna, jalur, dan sandi diperlukan.
PATH_KEYEnumJalur dan kunci diperlukan.
KEYEnumKunci API atau Token diperlukan.
USER_TOKENEnumNama pengguna dan token diperlukan.

BigQueryConfig

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addQueryParameter(name, type, value)BigQueryConfigMenambahkan parameter kueri ke BigQueryConfig ini.
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
printJson()StringMencetak representasi JSON objek ini.
setAccessToken(accessToken)BigQueryConfigMenetapkan token akses BigQueryConfig ini.
setBillingProjectId(billingProjectId)BigQueryConfigMenetapkan project ID penagihan BigQueryConfig ini.
setQuery(query)BigQueryConfigMenetapkan kueri SQL untuk BigQueryConfig ini.
setUseStandardSql(useStandardSql)BigQueryConfigMenentukan apakah kueri ditafsirkan sebagai SQL standar atau legacy.

BigQueryParameterType

Properti

PropertiJenisDeskripsi
STRINGEnumString.
INT64EnumBilangan bulat 64-bit.
BOOLEnumBoolean.
FLOAT64EnumBilangan floating point 64-bit.

Checkbox

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAllowOverride(allowOverride)CheckboxMengaktifkan penggantian untuk entri konfigurasi ini.
setHelpText(helpText)CheckboxMenyetel teks bantuan untuk entri konfigurasi ini.
setId(id)CheckboxMenetapkan ID unik untuk entri konfigurasi ini.
setIsDynamic(isDynamic)CheckboxMenetapkan status dinamis untuk entri konfigurasi ini.
setName(name)CheckboxMenetapkan nama tampilan untuk entri konfigurasi ini.

CommunityConnector

Properti

PropertiJenisDeskripsi
AggregationTypeAggregationTypeEnumerasi AggregationType.
AuthTypeAuthTypeEnumerasi AuthType.
BigQueryParameterTypeBigQueryParameterTypeEnumerasi BigQueryParameterType.
FieldTypeFieldTypeEnumerasi FieldType.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getConfig()ConfigMengembalikan objek Config.
getFields()FieldsMengembalikan objek Fields.
newAuthTypeResponse()GetAuthTypeResponseMenampilkan objek GetAuthTypeResponse baru.
newBigQueryConfig()BigQueryConfigMenampilkan objek BigQueryConfig baru.
newDebugError()DebugErrorMenampilkan objek DebugError baru.
newGetDataResponse()GetDataResponseMenampilkan objek GetDataResponse baru.
newGetSchemaResponse()GetSchemaResponseMenampilkan objek GetSchemaResponse baru.
newSetCredentialsResponse()SetCredentialsResponseMenampilkan objek SetCredentialsResponse baru.
newUserError()UserErrorMenampilkan objek UserError baru.

Config

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
newCheckbox()CheckboxMenampilkan entri konfigurasi kotak centang baru.
newInfo()InfoMenampilkan entri konfigurasi info baru.
newOptionBuilder()OptionBuilderMenampilkan builder opsi baru.
newSelectMultiple()SelectMultipleMenampilkan entri pilih beberapa konfigurasi yang baru.
newSelectSingle()SelectSingleMenampilkan satu entri konfigurasi tunggal pilihan baru.
newTextArea()TextAreaMenampilkan entri konfigurasi area teks baru.
newTextInput()TextInputMenampilkan entri konfigurasi input teks baru.
printJson()StringMencetak representasi JSON objek ini.
setDateRangeRequired(dateRangeRequired)ConfigJika true, rentang tanggal akan diberikan untuk permintaan getData().
setIsSteppedConfig(isSteppedConfig)ConfigJika true, getConfig() dipanggil lagi dengan konfigurasi pengguna saat ini.

DataStudioApp

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
createCommunityConnector()CommunityConnectorMembuat Konektor Komunitas baru.

DebugError

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
printJson()StringMencetak representasi JSON objek ini.
setText(text)DebugErrorMenetapkan teks error debug, yang hanya ditampilkan kepada admin.
throwException()voidMemicu kemunculan pengecualian ini.

Field

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getAggregation()AggregationTypeMenampilkan AggregationType dari Field ini.
getDescription()StringMenampilkan deskripsi Field ini.
getFormula()StringMenampilkan formula Field ini.
getGroup()StringMenampilkan grup Field ini.
getId()StringMenampilkan ID Field ini.
getIsReaggregatable()BooleanMenampilkan true jika kolom ini dapat digabungkan ulang, atau false jika tidak.
getName()StringMenampilkan nama Field ini.
getType()FieldTypeMenampilkan FieldType dari Field ini.
isDefault()BooleanMenampilkan true jika Field ini merupakan metrik atau dimensi default.
isDimension()BooleanMenampilkan true jika kolom ini adalah dimensi.
isHidden()BooleanMenampilkan true jika Field ini disembunyikan.
isMetric()BooleanMenampilkan true jika kolom ini berupa metrik.
setAggregation(aggregation)FieldMenetapkan jenis agregasi Field ini.
setDescription(description)FieldMenetapkan deskripsi Field ini.
setFormula(formula)FieldMenetapkan formula Field ini.
setGroup(group)FieldMenetapkan grup Field ini.
setId(id)FieldMenetapkan ID Field ini.
setIsHidden(isHidden)FieldMenetapkan status tersembunyi Field ini.
setIsReaggregatable(isReaggregatable)FieldMenetapkan status yang diizinkan agregasi ulang untuk Field.
setName(name)FieldMenetapkan nama Field ini.
setType(type)FieldMenetapkan FieldType untuk Field ini.

FieldType

Properti

PropertiJenisDeskripsi
YEAREnumTahun dalam format YYYY, misalnya 2017.
YEAR_QUARTEREnumTahun dan kuartal dalam format YYYYQ seperti 20171.
YEAR_MONTHEnumTahun dan bulan dalam format YYYYMM, misalnya 201703.
YEAR_WEEKEnumTahun dan minggu dalam format YYYYwww seperti 201707.
YEAR_MONTH_DAYEnumTahun, bulan, dan hari dalam format YYYYMMDD seperti 20170317.
YEAR_MONTH_DAY_HOUREnumTahun, bulan, hari, dan jam dalam format YYYYMMDDHH seperti 2017031703.
YEAR_MONTH_DAY_MINUTEEnumTahun, bulan, hari, jam, dan menit dalam format YYYYMMDDHHmm seperti 201703170230.
YEAR_MONTH_DAY_SECONDEnumTahun, bulan, hari, jam, menit, dan detik dalam format YYYYMMDDHHmmss seperti 20170317023017.
QUARTEREnumKuartal dalam format 1, 2, 3, atau 4).
MONTHEnumBulan dalam format MM, seperti 03.
WEEKEnumMinggu dalam format WW, misalnya 07.
MONTH_DAYEnumBulan dan hari dalam format MMDD, seperti 0317.
DAY_OF_WEEKEnumAngka dalam rentang [0,6] dengan 0 mewakili hari Minggu.
DAYEnumHari dalam format DD seperti 17.
HOUREnumJam dalam format HH seperti 13.
MINUTEEnumMenit dalam format mm seperti 12.
DURATIONEnumDurasi waktu dalam detik.
COUNTRYEnumNegara seperti Amerika Serikat.
COUNTRY_CODEEnumKode negara seperti AS.
CONTINENTEnumBenua seperti Amerika.
CONTINENT_CODEEnumKode benua seperti 019.
SUB_CONTINENTEnumSubbenua seperti Amerika Utara.
SUB_CONTINENT_CODEEnumKode subbenua seperti 003.
REGIONEnumWilayah seperti California.
REGION_CODEEnumKode wilayah, misalnya CA.
CITYEnumKota seperti Jakarta.
CITY_CODEEnumKode kota seperti 1014044.
METROEnumMetro seperti San Francisco-Oakland-San Jose CA.
METRO_CODEEnumKode metro seperti 200807.
LATITUDE_LONGITUDEEnumPasangan garis bujur seperti 51.5074, -0.1278.
NUMBEREnumAngka desimal.
PERCENTEnumPersentase desimal (bisa lebih dari 1,0).
TEXTEnumTeks bentuk bebas.
BOOLEANEnumNilai boolean true atau false.
URLEnumURL seperti teks seperti https://google.com.
HYPERLINKEnumHyperlink.
IMAGEEnumGambar.
IMAGE_LINKEnumLink gambar.
CURRENCY_AEDEnumMata uang dari AED.
CURRENCY_ALLEnumMata uang dari ALL.
CURRENCY_ARSEnumMata uang dari ARS.
CURRENCY_AUDEnumMata uang dari AUD.
CURRENCY_BDTEnumMata uang dari BDT.
CURRENCY_BGNEnumMata uang dari BGN.
CURRENCY_BOBEnumMata uang dari BOB.
CURRENCY_BRLEnumMata uang dari BRL.
CURRENCY_CADEnumMata uang dari CAD.
CURRENCY_CDFEnumMata uang dari CDF.
CURRENCY_CHFEnumMata uang dari CHF.
CURRENCY_CLPEnumMata uang dari CLP.
CURRENCY_CNYEnumMata uang dari CNY.
CURRENCY_COPEnumMata uang dari COP.
CURRENCY_CRCEnumMata uang dari CRC.
CURRENCY_CZKEnumMata uang dari CZK.
CURRENCY_DKKEnumMata uang dari DKK.
CURRENCY_DOPEnumMata uang dari DOP.
CURRENCY_EGPEnumMata uang dari EGP.
CURRENCY_ETBEnumMata uang dari ETB.
CURRENCY_EUREnumMata uang dari EUR.
CURRENCY_GBPEnumMata uang dari GBP.
CURRENCY_HKDEnumMata uang dari HKD.
CURRENCY_HRKEnumMata uang dari HRK.
CURRENCY_HUFEnumMata uang dari HUF.
CURRENCY_IDREnumMata uang dari IDR.
CURRENCY_ILSEnumMata uang dari ILS.
CURRENCY_INREnumMata uang dari INR.
CURRENCY_IRREnumMata uang dari IRR.
CURRENCY_ISKEnumMata uang dari ISK.
CURRENCY_JMDEnumMata uang dari JMD.
CURRENCY_JPYEnumMata uang dari JPY.
CURRENCY_KRWEnumMata uang dari KRW.
CURRENCY_LKREnumMata uang dari LKR.
CURRENCY_LTLEnumMata uang dari LTL.
CURRENCY_MNTEnumMata uang dari MNT.
CURRENCY_MVREnumMata uang dari MVR.
CURRENCY_MXNEnumMata uang dari MXN.
CURRENCY_MYREnumMata uang dari MYR.
CURRENCY_NGNEnumMata uang dari NGN.
CURRENCY_NOKEnumMata uang dari NOK.
CURRENCY_NZDEnumMata uang dari NZD.
CURRENCY_PABEnumMata uang dari PAB.
CURRENCY_PENEnumMata uang dari PEN.
CURRENCY_PHPEnumMata uang dari PHP.
CURRENCY_PKREnumMata uang dari PKR.
CURRENCY_PLNEnumMata uang dari PLN.
CURRENCY_RONEnumMata uang dari RON.
CURRENCY_RSDEnumMata uang dari RSD.
CURRENCY_RUBEnumMata uang dari RUB.
CURRENCY_SAREnumMata uang dari SAR.
CURRENCY_SEKEnumMata uang dari SEK.
CURRENCY_SGDEnumMata uang dari SGD.
CURRENCY_THBEnumMata uang dari THB.
CURRENCY_TRYEnumMata uang dari TRY.
CURRENCY_TWDEnumMata uang dari TWD.
CURRENCY_TZSEnumMata uang dari TZS.
CURRENCY_UAHEnumMata uang dari UAH.
CURRENCY_USDEnumMata uang dari USD.
CURRENCY_UYUEnumMata uang dari UYU.
CURRENCY_VEFEnumMata uang dari VEF.
CURRENCY_VNDEnumMata uang dari VND.
CURRENCY_YEREnumMata uang dari YER.
CURRENCY_ZAREnumMata uang dari ZAR.

Fields

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
asArray()Field[]Menampilkan tampilan objek ini sebagai array.
build()Object[]Memvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
forIds(ids)FieldsMenampilkan objek Fields baru yang difilter ke Field dengan ID di ids.
getDefaultDimension()FieldMenampilkan dimensi default yang akan digunakan untuk kumpulan kolom.
getDefaultMetric()FieldMenampilkan metrik default yang akan digunakan untuk kumpulan kolom.
getFieldById(fieldId)FieldMenampilkan kolom dengan ID yang diberikan, atau null jika tidak ada kolom dengan ID tersebut di objek Fields ini.
newDimension()FieldMenampilkan dimensi baru Field.
newMetric()FieldMenampilkan metrik baru Field.
setDefaultDimension(fieldId)voidMenetapkan dimensi default yang akan digunakan untuk kumpulan kolom.
setDefaultMetric(fieldId)voidMenetapkan metrik default yang akan digunakan untuk kumpulan kolom.

GetAuthTypeResponse

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
printJson()StringMencetak representasi JSON objek ini.
setAuthType(authType)GetAuthTypeResponseMenetapkan AuthType builder.
setHelpUrl(helpUrl)GetAuthTypeResponseMenetapkan URL bantuan builder.

GetDataResponse

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addAllRows(rows)GetDataResponseMenambahkan beberapa baris data ke GetDataResponse ini.
addRow(row)GetDataResponseMenambahkan baris data ke GetDataResponse ini.
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
setFields(fields)GetDataResponseMenetapkan Fields builder.
setFiltersApplied(filtersApplied)GetDataResponseMenetapkan status filter yang diterapkan untuk builder ini.

GetSchemaResponse

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
printJson()StringMencetak representasi JSON objek ini.
setFields(fields)GetSchemaResponseMenetapkan Fields builder.

Info

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setId(id)InfoMenetapkan ID unik untuk entri konfigurasi ini.
setText(text)InfoMenetapkan teks untuk entri konfigurasi ini.

OptionBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setLabel(label)OptionBuilderMenetapkan label builder opsi ini.
setValue(value)OptionBuilderMenetapkan nilai builder opsi ini.

SelectMultiple

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addOption(optionBuilder)SelectMultipleMenambahkan opsi pilih baru.
setAllowOverride(allowOverride)SelectMultipleMengaktifkan penggantian untuk entri konfigurasi ini.
setHelpText(helpText)SelectMultipleMenyetel teks bantuan untuk entri konfigurasi ini.
setId(id)SelectMultipleMenetapkan ID unik untuk entri konfigurasi ini.
setIsDynamic(isDynamic)SelectMultipleMenetapkan status dinamis untuk entri konfigurasi ini.
setName(name)SelectMultipleMenetapkan nama tampilan untuk entri konfigurasi ini.

SelectSingle

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addOption(optionBuilder)SelectSingleMenambahkan opsi pilih baru.
setAllowOverride(allowOverride)SelectSingleMengaktifkan penggantian untuk entri konfigurasi ini.
setHelpText(helpText)SelectSingleMenyetel teks bantuan untuk entri konfigurasi ini.
setId(id)SelectSingleMenetapkan ID unik untuk entri konfigurasi ini.
setIsDynamic(isDynamic)SelectSingleMenetapkan status dinamis untuk entri konfigurasi ini.
setName(name)SelectSingleMenetapkan nama tampilan untuk entri konfigurasi ini.

SetCredentialsResponse

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
build()ObjectMemvalidasi objek ini dan menampilkannya dalam format yang diperlukan oleh Data Studio.
printJson()StringMencetak representasi JSON objek ini.
setIsValid(isValid)SetCredentialsResponseMenetapkan status valid SetCredentialsResponse ini.

TextArea

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAllowOverride(allowOverride)TextAreaMengaktifkan penggantian untuk entri konfigurasi ini.
setHelpText(helpText)TextAreaMenyetel teks bantuan untuk entri konfigurasi ini.
setId(id)TextAreaMenetapkan ID unik untuk entri konfigurasi ini.
setIsDynamic(isDynamic)TextAreaMenetapkan status dinamis untuk entri konfigurasi ini.
setName(name)TextAreaMenetapkan nama tampilan untuk entri konfigurasi ini.
setPlaceholder(placeholder)TextAreaMenetapkan teks placeholder untuk entri konfigurasi ini.

TextInput

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAllowOverride(allowOverride)TextInputMengaktifkan penggantian untuk entri konfigurasi ini.
setHelpText(helpText)TextInputMenyetel teks bantuan untuk entri konfigurasi ini.
setId(id)TextInputMenetapkan ID unik untuk entri konfigurasi ini.
setIsDynamic(isDynamic)TextInputMenetapkan status dinamis untuk entri konfigurasi ini.
setName(name)TextInputMenetapkan nama tampilan untuk entri konfigurasi ini.
setPlaceholder(placeholder)TextInputMenetapkan teks placeholder untuk entri konfigurasi ini.

UserError

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
printJson()StringMencetak representasi JSON objek ini.
setDebugText(text)UserErrorMenetapkan teks error debug, yang hanya ditampilkan kepada admin.
setText(text)UserErrorMenetapkan teks error pengguna.
throwException()voidMemicu kemunculan pengecualian ini.