Data Studio Service

Data Studio

Dịch vụ này cho phép tập lệnh truy cập và sửa đổi Trình kết nối cộng đồng của Data Studio.

Lớp

TênMô tả ngắn
AggregationTypeMột enum xác định các loại tổng hợp có thể được đặt cho một Field.
AuthTypeMột enum xác định các loại xác thực có thể được đặt cho một trình kết nối.
BigQueryConfigMột đối tượng cấu hình cho trình kết nối BigQuery gốc.
BigQueryParameterTypeMột enum xác định các loại tham số BigQuery mà bạn có thể đặt.
CheckboxChứa thông tin về hộp đánh dấu cho cấu hình.
CommunityConnectorCommunityConnector cho phép các tập lệnh truy cập vào trình tạo và tiện ích để hỗ trợ việc phát triển Trình kết nối cộng đồng cho Data Studio.
ConfigChứa các mục cấu hình cho một trình kết nối.
DataStudioAppDataStudioApp cho phép các tập lệnh tương tác với các tính năng dành cho nhà phát triển của Data Studio.
DebugErrorLỗi mà chỉ quản trị viên của trình kết nối mới nhìn thấy.
FieldChứa dữ liệu liên quan đến trường.
FieldTypeMột enum xác định các loại có thể được đặt cho một Field.
FieldsChứa một nhóm Field cho trình kết nối cộng đồng.
GetAuthTypeResponseTrình tạo để tạo phản hồi getAuthType() cho dự án tập lệnh của bạn.
GetDataResponseTrình tạo để tạo phản hồi getData() cho dự án tập lệnh của bạn.
GetSchemaResponseTrình tạo để tạo phản hồi getSchema() cho dự án tập lệnh của bạn.
InfoChứa dữ liệu thông tin cho cấu hình.
OptionBuilderTrình tạo để tạo các lựa chọn cho SelectSingleSelectMultiple.
SelectMultipleChứa thông tin chọn nhiều cho cấu hình.
SelectSingleChứa thông tin chọn một lần cho cấu hình.
SetCredentialsResponseTrình tạo để tạo phản hồi setCredentials() cho dự án tập lệnh của bạn.
TextAreaChứa thông tin về vùng văn bản cho cấu hình.
TextInputChứa thông tin đầu vào văn bản cho cấu hình.
UserErrorLỗi hiển thị cho người dùng trình kết nối.

AggregationType

Thuộc tính

Thuộc tínhLoạiMô tả
AVGEnumTrung bình.
COUNTEnumSố lượng.
COUNT_DISTINCTEnumSố lượng giá trị riêng biệt.
MAXEnumTối đa
MINEnumT.thiểu
SUMEnumTổng.
AUTOEnumTự động.

AuthType

Thuộc tính

Thuộc tínhLoạiMô tả
NONEEnumKhông cần uỷ quyền.
OAUTH2EnumCần có uỷ quyền OAuth2.
USER_PASSEnumBạn cần có thông tin đăng nhập gồm tên người dùng và mật khẩu.
PATH_USER_PASSEnumBạn cần có tên người dùng, đường dẫn và mật khẩu.
PATH_KEYEnumBạn cần cung cấp đường dẫn và khoá.
KEYEnumCần có khoá API hoặc mã thông báo.
USER_TOKENEnumBạn cần có tên người dùng và mã thông báo.

BigQueryConfig

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addQueryParameter(name, type, value)BigQueryConfigThêm một tham số truy vấn vào BigQueryConfig này.
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
printJson()StringIn biểu thị JSON của đối tượng này.
setAccessToken(accessToken)BigQueryConfigĐặt mã truy cập của BigQueryConfig này.
setBillingProjectId(billingProjectId)BigQueryConfigĐặt mã dự án thanh toán của BigQueryConfig này.
setQuery(query)BigQueryConfigĐặt truy vấn SQL của BigQueryConfig này.
setUseStandardSql(useStandardSql)BigQueryConfigXác định xem truy vấn được diễn giải là SQL chuẩn hay SQL cũ.

BigQueryParameterType

Thuộc tính

Thuộc tínhLoạiMô tả
STRINGEnumChuỗi.
INT64EnumSố nguyên 64 bit.
BOOLEnumBoolean.
FLOAT64EnumSố có dấu phẩy động 64 bit.

Checkbox

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)CheckboxCho phép ghi đè cho mục cấu hình này.
setHelpText(helpText)CheckboxĐặt văn bản trợ giúp cho mục nhập cấu hình này.
setId(id)CheckboxĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setIsDynamic(isDynamic)CheckboxĐặt trạng thái động cho mục cấu hình này.
setName(name)CheckboxĐặt tên hiển thị cho mục cấu hình này.

CommunityConnector

Thuộc tính

Thuộc tínhLoạiMô tả
AggregationTypeAggregationTypeBảng liệt kê AggregationType.
AuthTypeAuthTypeBảng liệt kê AuthType.
BigQueryParameterTypeBigQueryParameterTypeBảng liệt kê BigQueryParameterType.
FieldTypeFieldTypeBảng liệt kê FieldType.

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
getConfig()ConfigTrả về một đối tượng Config.
getFields()FieldsTrả về một đối tượng Fields.
newAuthTypeResponse()GetAuthTypeResponseTrả về một đối tượng GetAuthTypeResponse mới.
newBigQueryConfig()BigQueryConfigTrả về một đối tượng BigQueryConfig mới.
newDebugError()DebugErrorTrả về một đối tượng DebugError mới.
newGetDataResponse()GetDataResponseTrả về một đối tượng GetDataResponse mới.
newGetSchemaResponse()GetSchemaResponseTrả về một đối tượng GetSchemaResponse mới.
newSetCredentialsResponse()SetCredentialsResponseTrả về một đối tượng SetCredentialsResponse mới.
newUserError()UserErrorTrả về một đối tượng UserError mới.

Config

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
newCheckbox()CheckboxTrả về một mục cấu hình hộp đánh dấu mới.
newInfo()InfoTrả về một mục nhập cấu hình thông tin mới.
newOptionBuilder()OptionBuilderTrả về một trình tạo lựa chọn mới.
newSelectMultiple()SelectMultipleTrả về một mục cấu hình mới để chọn nhiều.
newSelectSingle()SelectSingleTrả về một mục cấu hình chọn một mục mới.
newTextArea()TextAreaTrả về một mục nhập cấu hình vùng văn bản mới.
newTextInput()TextInputTrả về một mục nhập cấu hình đầu vào văn bản mới.
printJson()StringIn biểu thị JSON của đối tượng này.
setDateRangeRequired(dateRangeRequired)ConfigNếu true, một phạm vi ngày sẽ được cung cấp cho các yêu cầu getData().
setIsSteppedConfig(isSteppedConfig)ConfigNếu true, getConfig() được gọi lại bằng cấu hình người dùng hiện tại.

DataStudioApp

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
createCommunityConnector()CommunityConnectorTạo một Trình kết nối cộng đồng mới.

DebugError

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
printJson()StringIn biểu thị JSON của đối tượng này.
setText(text)DebugErrorĐặt văn bản của lỗi gỡ lỗi, chỉ quản trị viên mới thấy được lỗi này.
throwException()voidKích hoạt để gửi ngoại lệ này.

Field

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
getAggregation()AggregationTypeTrả về AggregationType của Field này.
getDescription()StringTrả về nội dung mô tả của Field này.
getFormula()StringTrả về công thức của Field này.
getGroup()StringTrả về nhóm của Field này.
getId()StringTrả về mã nhận dạng của Field này.
getIsReaggregatable()BooleanTrả về true nếu bạn có thể tổng hợp lại trường này, nếu không thì trả về false.
getName()StringTrả về tên của Field này.
getType()FieldTypeTrả về FieldType của Field này.
isDefault()BooleanTrả về true nếu Field này là chỉ số hoặc phương diện mặc định.
isDimension()BooleanTrả về true nếu trường này là một phương diện.
isHidden()BooleanTrả về true nếu Field này bị ẩn.
isMetric()BooleanTrả về true nếu trường này là một chỉ số.
setAggregation(aggregation)FieldĐặt loại tổng hợp của Field này.
setDescription(description)FieldĐặt nội dung mô tả cho Field này.
setFormula(formula)FieldĐặt công thức cho Field này.
setGroup(group)FieldĐặt nhóm của Field này.
setId(id)FieldĐặt mã nhận dạng của Field này.
setIsHidden(isHidden)FieldĐặt trạng thái ẩn của Field này.
setIsReaggregatable(isReaggregatable)FieldĐặt trạng thái được phép tổng hợp lại cho một Field.
setName(name)FieldĐặt tên cho Field này.
setType(type)FieldĐặt FieldType của Field này.

FieldType

Thuộc tính

Thuộc tínhLoạiMô tả
YEAREnumNăm ở định dạng YYYY, chẳng hạn như 2017.
YEAR_QUARTEREnumNăm và quý theo định dạng YYYYQ, chẳng hạn như 20171.
YEAR_MONTHEnumNăm và tháng ở định dạng YYYYMM, chẳng hạn như 201703.
YEAR_WEEKEnumNăm và tuần theo định dạng YYYYww, chẳng hạn như 201707.
YEAR_MONTH_DAYEnumNăm, tháng và ngày theo định dạng YYYYMMDD, chẳng hạn như 20170317.
YEAR_MONTH_DAY_HOUREnumNăm, tháng, ngày và giờ ở định dạng YYYYMMDDHH, chẳng hạn như 2017031703.
YEAR_MONTH_DAY_MINUTEEnumNăm, tháng, ngày, giờ và phút theo định dạng YYYYMMDDHHmm, chẳng hạn như 201703170230.
YEAR_MONTH_DAY_SECONDEnumNăm, tháng, ngày, giờ, phút và giây ở định dạng YYYYMMDDHHmmss, chẳng hạn như 20170317023017.
QUARTEREnumQuý ở định dạng 1, 2, 3 hoặc 4).
MONTHEnumTháng ở định dạng MM, chẳng hạn như 03.
WEEKEnumTuần ở định dạng ww, chẳng hạn như 07.
MONTH_DAYEnumTháng và ngày theo định dạng MMDD, chẳng hạn như 0317.
DAY_OF_WEEKEnumMột số trong phạm vi [0,6], trong đó 0 biểu thị Chủ Nhật.
DAYEnumNgày ở định dạng DD, chẳng hạn như 17.
HOUREnumGiờ ở định dạng HH, chẳng hạn như 13.
MINUTEEnumPhút ở định dạng mm, chẳng hạn như 12.
DURATIONEnumThời lượng tính bằng giây.
COUNTRYEnumMột quốc gia, chẳng hạn như Hoa Kỳ.
COUNTRY_CODEEnumMã quốc gia, chẳng hạn như Hoa Kỳ.
CONTINENTEnumMột lục địa, chẳng hạn như Châu Mỹ.
CONTINENT_CODEEnumMã lục địa, chẳng hạn như 019.
SUB_CONTINENTEnumMột tiểu lục địa như Bắc Mỹ.
SUB_CONTINENT_CODEEnumMã tiểu lục địa, chẳng hạn như 003.
REGIONEnumMột vùng như California.
REGION_CODEEnumMã vùng, chẳng hạn như CA.
CITYEnumMột thành phố như Mountain View.
CITY_CODEEnumMã thành phố, chẳng hạn như 1014044.
METROEnumMột khu vực đô thị như San Francisco-Oakland-San Jose, CA.
METRO_CODEEnumMã vùng đô thị, chẳng hạn như 200807.
LATITUDE_LONGITUDEEnumMột cặp vĩ độ và kinh độ, chẳng hạn như 51.5074, -0.1278.
NUMBEREnumMột số thập phân.
PERCENTEnumTỷ lệ phần trăm thập phân (có thể lớn hơn 1,0).
TEXTEnumVăn bản dạng tự do.
BOOLEANEnumGiá trị boolean true hoặc false.
URLEnumMột URL dưới dạng văn bản, chẳng hạn như https://google.com.
HYPERLINKEnumSiêu liên kết.
IMAGEEnumMột hình ảnh.
IMAGE_LINKEnumĐường liên kết của hình ảnh.
CURRENCY_AEDEnumĐơn vị tiền tệ là AED.
CURRENCY_ALLEnumĐơn vị tiền tệ từ ALL.
CURRENCY_ARSEnumĐơn vị tiền tệ là ARS.
CURRENCY_AUDEnumĐơn vị tiền tệ là AUD.
CURRENCY_BDTEnumĐơn vị tiền tệ là BDT.
CURRENCY_BGNEnumĐơn vị tiền tệ là BGN.
CURRENCY_BOBEnumĐơn vị tiền tệ của Bolivia.
CURRENCY_BRLEnumĐơn vị tiền tệ là BRL.
CURRENCY_CADEnumĐơn vị tiền tệ là CAD.
CURRENCY_CDFEnumĐơn vị tiền tệ của CDF.
CURRENCY_CHFEnumĐơn vị tiền tệ là CHF.
CURRENCY_CLPEnumĐơn vị tiền tệ bằng CLP.
CURRENCY_CNYEnumĐơn vị tiền tệ là CNY.
CURRENCY_COPEnumĐơn vị tiền tệ là COP.
CURRENCY_CRCEnumĐơn vị tiền tệ là CRC.
CURRENCY_CZKEnumĐơn vị tiền tệ từ CZK.
CURRENCY_DKKEnumĐơn vị tiền tệ là DKK.
CURRENCY_DOPEnumĐơn vị tiền tệ của DOP.
CURRENCY_EGPEnumĐơn vị tiền tệ là EGP.
CURRENCY_ETBEnumĐơn vị tiền tệ là ETB.
CURRENCY_EUREnumĐơn vị tiền tệ là EUR.
CURRENCY_GBPEnumĐơn vị tiền tệ là GBP.
CURRENCY_HKDEnumĐơn vị tiền tệ là HKD.
CURRENCY_HRKEnumĐơn vị tiền tệ HRK.
CURRENCY_HUFEnumĐơn vị tiền tệ là HUF.
CURRENCY_IDREnumĐơn vị tiền tệ là IDR.
CURRENCY_ILSEnumĐơn vị tiền tệ là ILS.
CURRENCY_INREnumĐơn vị tiền tệ là INR.
CURRENCY_IRREnumĐơn vị tiền tệ là IRR.
CURRENCY_ISKEnumĐơn vị tiền tệ từ ISK.
CURRENCY_JMDEnumĐơn vị tiền tệ là JMD.
CURRENCY_JPYEnumĐơn vị tiền tệ là JPY.
CURRENCY_KRWEnumĐơn vị tiền tệ là KRW.
CURRENCY_LKREnumĐơn vị tiền tệ là LKR.
CURRENCY_LTLEnumĐơn vị tiền tệ từ LTL.
CURRENCY_MNTEnumĐơn vị tiền tệ là MNT.
CURRENCY_MVREnumĐơn vị tiền tệ là MVR.
CURRENCY_MXNEnumĐơn vị tiền tệ là MXN.
CURRENCY_MYREnumĐơn vị tiền tệ là MYR.
CURRENCY_NGNEnumĐơn vị tiền tệ là NGN.
CURRENCY_NOKEnumĐơn vị tiền tệ là NOK.
CURRENCY_NZDEnumĐơn vị tiền tệ là NZD.
CURRENCY_PABEnumĐơn vị tiền tệ của PAB.
CURRENCY_PENEnumĐơn vị tiền tệ là PEN.
CURRENCY_PHPEnumĐơn vị tiền tệ là PHP.
CURRENCY_PKREnumĐơn vị tiền tệ là PKR.
CURRENCY_PLNEnumĐơn vị tiền tệ là PLN.
CURRENCY_RONEnumĐơn vị tiền tệ là RON.
CURRENCY_RSDEnumĐơn vị tiền tệ là RSD.
CURRENCY_RUBEnumĐơn vị tiền tệ là RUB.
CURRENCY_SAREnumĐơn vị tiền tệ là SAR.
CURRENCY_SEKEnumĐơn vị tiền tệ là SEK.
CURRENCY_SGDEnumĐơn vị tiền tệ là SGD.
CURRENCY_THBEnumĐơn vị tiền tệ là THB.
CURRENCY_TRYEnumĐơn vị tiền tệ là TRY.
CURRENCY_TWDEnumĐơn vị tiền tệ là TWD.
CURRENCY_TZSEnumĐơn vị tiền tệ là TZS.
CURRENCY_UAHEnumĐơn vị tiền tệ là UAH.
CURRENCY_USDEnumĐơn vị tiền tệ là USD.
CURRENCY_UYUEnumĐơn vị tiền tệ là UYU.
CURRENCY_VEFEnumĐơn vị tiền tệ là VEF.
CURRENCY_VNDEnumĐơn vị tiền tệ là VND.
CURRENCY_YEREnumĐơn vị tiền tệ là YER.
CURRENCY_ZAREnumĐơn vị tiền tệ là ZAR.

Fields

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
asArray()Field[]Trả về một khung hiển thị của đối tượng này dưới dạng một mảng.
build()Object[]Xác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
forIds(ids)FieldsTrả về một đối tượng Fields mới được lọc thành Field có mã nhận dạng trong ids.
getDefaultDimension()FieldTrả về phương diện mặc định sẽ được dùng cho tập hợp các trường.
getDefaultMetric()FieldTrả về chỉ số mặc định sẽ được dùng cho tập hợp các trường.
getFieldById(fieldId)FieldTrả về một trường có mã nhận dạng nhất định hoặc null nếu không có trường nào có mã nhận dạng đó trong đối tượng Fields này.
newDimension()FieldTrả về một phương diện mới Field.
newMetric()FieldTrả về một chỉ số mới Field.
setDefaultDimension(fieldId)voidĐặt phương diện mặc định sẽ được dùng cho nhóm trường.
setDefaultMetric(fieldId)voidĐặt chỉ số mặc định sẽ được dùng cho nhóm trường.

GetAuthTypeResponse

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
printJson()StringIn biểu thị JSON của đối tượng này.
setAuthType(authType)GetAuthTypeResponseĐặt AuthType của trình tạo.
setHelpUrl(helpUrl)GetAuthTypeResponseĐặt URL trợ giúp của trình tạo.

GetDataResponse

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addAllRows(rows)GetDataResponseThêm nhiều hàng dữ liệu vào GetDataResponse này.
addRow(row)GetDataResponseThêm một hàng dữ liệu vào GetDataResponse này.
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
setFields(fields)GetDataResponseĐặt Fields của trình tạo.
setFiltersApplied(filtersApplied)GetDataResponseĐặt trạng thái đã áp dụng bộ lọc cho trình tạo này.

GetSchemaResponse

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
printJson()StringIn biểu thị JSON của đối tượng này.
setFields(fields)GetSchemaResponseĐặt Fields của trình tạo.

Info

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setId(id)InfoĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setText(text)InfoĐặt văn bản cho mục nhập cấu hình này.

OptionBuilder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setLabel(label)OptionBuilderĐặt nhãn cho trình tạo lựa chọn này.
setValue(value)OptionBuilderĐặt giá trị của trình tạo lựa chọn này.

SelectMultiple

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addOption(optionBuilder)SelectMultipleThêm một lựa chọn mới vào trình đơn chọn.
setAllowOverride(allowOverride)SelectMultipleCho phép ghi đè cho mục cấu hình này.
setHelpText(helpText)SelectMultipleĐặt văn bản trợ giúp cho mục nhập cấu hình này.
setId(id)SelectMultipleĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setIsDynamic(isDynamic)SelectMultipleĐặt trạng thái động cho mục cấu hình này.
setName(name)SelectMultipleĐặt tên hiển thị cho mục cấu hình này.

SelectSingle

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addOption(optionBuilder)SelectSingleThêm một lựa chọn mới vào trình đơn chọn.
setAllowOverride(allowOverride)SelectSingleCho phép ghi đè cho mục cấu hình này.
setHelpText(helpText)SelectSingleĐặt văn bản trợ giúp cho mục nhập cấu hình này.
setId(id)SelectSingleĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setIsDynamic(isDynamic)SelectSingleĐặt trạng thái động cho mục cấu hình này.
setName(name)SelectSingleĐặt tên hiển thị cho mục cấu hình này.

SetCredentialsResponse

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
build()ObjectXác thực đối tượng này và trả về đối tượng ở định dạng mà Data Studio cần.
printJson()StringIn biểu thị JSON của đối tượng này.
setIsValid(isValid)SetCredentialsResponseĐặt trạng thái hợp lệ của SetCredentialsResponse này.

TextArea

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)TextAreaCho phép ghi đè cho mục cấu hình này.
setHelpText(helpText)TextAreaĐặt văn bản trợ giúp cho mục nhập cấu hình này.
setId(id)TextAreaĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setIsDynamic(isDynamic)TextAreaĐặt trạng thái động cho mục cấu hình này.
setName(name)TextAreaĐặt tên hiển thị cho mục cấu hình này.
setPlaceholder(placeholder)TextAreaĐặt văn bản phần giữ chỗ cho mục nhập cấu hình này.

TextInput

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)TextInputCho phép ghi đè cho mục cấu hình này.
setHelpText(helpText)TextInputĐặt văn bản trợ giúp cho mục nhập cấu hình này.
setId(id)TextInputĐặt mã nhận dạng duy nhất cho mục nhập cấu hình này.
setIsDynamic(isDynamic)TextInputĐặt trạng thái động cho mục cấu hình này.
setName(name)TextInputĐặt tên hiển thị cho mục cấu hình này.
setPlaceholder(placeholder)TextInputĐặt văn bản phần giữ chỗ cho mục nhập cấu hình này.

UserError

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
printJson()StringIn biểu thị JSON của đối tượng này.
setDebugText(text)UserErrorĐặt văn bản của lỗi gỡ lỗi, chỉ quản trị viên mới thấy được lỗi này.
setText(text)UserErrorĐặt văn bản lỗi của người dùng.
throwException()voidKích hoạt để gửi ngoại lệ này.