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 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.
BigQueryConfigĐố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.
CommunityConnectorTrình kết nối cộng đồng cho phép các tập lệnh truy cập vào trình tạo và tiện ích để hỗ trợ 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.
DataStudioAppỨng dụngDataStudio cho phép tập lệnh tương tác với các tính năng dành cho nhà phát triển cho Data Studio.
DebugErrorLỗi 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 Field.
FieldsChứa một tập hợp 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.
GetDataResponseTrình tạo để tạo phản hồi getData() cho dự án tập lệnh.
GetSchemaResponseTrình tạo để tạo phản hồi getSchema() cho dự án tập lệnh.
InfoChứa dữ liệu thông tin cho cấu hình.
OptionBuilderTrình tạo để tạo các tuỳ chọn cho SelectSingleSelectMultiple.
SelectMultipleChứa nhiều thông tin chọn lọc cho cấu hình.
SelectSingleChứa thông tin đơn lẻ đã chọn cho cấu hình.
SetCredentialsResponseTrình tạo để tạo phản hồi setCredentials() cho dự án tập lệnh.
TextAreaChứa thông tin về vùng văn bản cho cấu hình.
TextInputChứa thông tin nhập văn bản cho cấu hình.
UserErrorLỗi hiển thị cho người dùng của trình kết nối.

AggregationType

Thuộc tính

Thuộc tínhLoạiMô tả
AVGEnumTrung bình.
COUNTEnumĐếm.
COUNT_DISTINCTEnumĐếm 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ó quyền uỷ quyền OAuth2.
USER_PASSEnumCần có thông tin xác thực tên người dùng và mật khẩu.
PATH_USER_PASSEnumCần có tên người dùng, đường dẫn và mật khẩu.
PATH_KEYEnumCần có đường dẫn và khoá.
KEYEnumCần có Khoá API hoặc Mã thông báo.
USER_TOKENEnumCần có tên người dùng và mã thông báo.

BigQueryConfig

Phương thức

Phương thứcLoại 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 nội dung đại diện 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ứcLoại dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)CheckboxBật chế độ ghi đè cho mục nhập 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 cấu hình này.
setIsDynamic(isDynamic)CheckboxĐặt trạng thái động cho mục nhập cấu hình này.
setName(name)CheckboxĐặt tên hiển thị cho mục nhập cấu hình này.

CommunityConnector

Thuộc tính

Thuộc tínhLoạiMô tả
AggregationTypeAggregationTypeLiệt kê AggregationType.
AuthTypeAuthTypeLiệt kê AuthType.
BigQueryParameterTypeBigQueryParameterTypeLiệt kê BigQueryParameterType.
FieldTypeFieldTypeLiệt kê FieldType.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getConfig()ConfigTrả về đối tượng Config.
getFields()FieldsTrả về đố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ứcLoại 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ục cấu hình hộp đánh dấu mới.
newInfo()InfoTrả về mục nhập cấu hình thông tin mới.
newOptionBuilder()OptionBuilderTrả về một trình tạo tuỳ chọn mới.
newSelectMultiple()SelectMultipleTrả về một mục nhập cấu hình chọn nhiều mục mới.
newSelectSingle()SelectSingleTrả về một mục cấu hình mới được chọn.
newTextArea()TextAreaTrả về mục nhập cấu hình vùng văn bản mới.
newTextInput()TextInputTrả về mục nhập cấu hình nhập văn bản mới.
printJson()StringIn nội dung đại diện JSON của đối tượng này.
setDateRangeRequired(dateRangeRequired)ConfigNếu là true, phạm vi ngày sẽ được cung cấp cho các yêu cầu getData().
setIsSteppedConfig(isSteppedConfig)ConfigNếu true, getConfig() sẽ đượ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ứcLoại 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ứcLoại dữ liệu trả vềMô tả ngắn
printJson()StringIn nội dung đại diện 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 xem được.
throwException()voidKích hoạt trường hợp ngoại lệ này.

Field

Phương thức

Phương thứcLoại 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 trường này có thể được tổng hợp lại, false nếu không.
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ả của Field này.
setFormula(formula)FieldĐặt công thức của 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 cho phép tổng hợp lại cho 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 ở định dạng YYYYww, chẳng hạn như 201707.
YEAR_MONTH_DAYEnumNăm, tháng và ngày ở đị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 theo định dạng ww, chẳng hạn như 07.
MONTH_DAYEnumTháng và ngày ở định dạng MMDD, chẳng hạn như 0317.
DAY_OF_WEEKEnumMột số trong phạm vi [0,6], trong đó 0 đại diện cho 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ư US.
CONTINENTEnumMột lục địa 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 khu vực 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 tuyến tàu điện ngầm như San Francisco-Oakland-San Jose, CA.
METRO_CODEEnumMã tàu điện ngầm, chẳng hạn như 200807.
LATITUDE_LONGITUDEEnumCặp vĩ độ kinh độ, chẳng hạn như 51.5074, -0.1278.
NUMBEREnumSố 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.
URLEnumURL dưới dạng văn bản, chẳng hạn như https://google.com.
HYPERLINKEnumSiêu liên kết.
IMAGEEnumHình ảnh.
IMAGE_LINKEnumĐường liên kết của hình ảnh.
CURRENCY_AEDEnumĐơn vị tiền tệ là dirham Các Tiểu vương quốc Ả Rập Thống nhất (AED).
CURRENCY_ALLEnumĐơn vị tiền tệ từ TẤT CẢ.
CURRENCY_ARSEnumĐơn vị tiền tệ là ARS.
CURRENCY_AUDEnumĐơn vị tiền tệ là đô la Úc.
CURRENCY_BDTEnumĐơn vị tiền tệ là BDT.
CURRENCY_BGNEnumĐơn vị tiền tệ từ BGN.
CURRENCY_BOBEnumĐơn vị tiền tệ của BOB.
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ệ từ CDF.
CURRENCY_CHFEnumĐơn vị tiền tệ từ CHF.
CURRENCY_CLPEnumĐơn vị tiền tệ từ CLP.
CURRENCY_CNYEnumĐơn vị tiền tệ từ CNY.
CURRENCY_COPEnumĐơn vị tiền tệ của COP.
CURRENCY_CRCEnumĐơn vị tiền tệ của CRC.
CURRENCY_CZKEnumĐơn vị tiền tệ từ CZK.
CURRENCY_DKKEnumĐơn vị tiền tệ từ 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ệ từ GBP.
CURRENCY_HKDEnumĐơn vị tiền tệ là đô la Hồng Kông.
CURRENCY_HRKEnumĐơn vị tiền tệ từ HRK.
CURRENCY_HUFEnumĐơn vị tiền tệ là HUF.
CURRENCY_IDREnumĐơn vị tiền tệ từ IDR.
CURRENCY_ILSEnumĐơn vị tiền tệ từ ILS.
CURRENCY_INREnumĐơn vị tiền tệ là INR.
CURRENCY_IRREnumĐơn vị tiền tệ của IRR.
CURRENCY_ISKEnumĐơn vị tiền tệ từ ISK.
CURRENCY_JMDEnumĐơn vị tiền tệ là đô la Jamaica.
CURRENCY_JPYEnumĐơn vị tiền tệ là JPY.
CURRENCY_KRWEnumĐơn vị tiền tệ từ KRW.
CURRENCY_LKREnumĐơn vị tiền tệ từ LKR.
CURRENCY_LTLEnumĐơn vị tiền tệ là LTL.
CURRENCY_MNTEnumĐơn vị tiền tệ từ MNT.
CURRENCY_MVREnumĐơn vị tiền tệ của MVR.
CURRENCY_MXNEnumĐơn vị tiền tệ từ MXN.
CURRENCY_MYREnumĐơn vị tiền tệ là ringgit Malaysia (MYR).
CURRENCY_NGNEnumĐơn vị tiền tệ là naira Nigeria (NGN).
CURRENCY_NOKEnumĐơn vị tiền tệ từ NOK.
CURRENCY_NZDEnumĐơn vị tiền tệ là NZD.
CURRENCY_PABEnumĐơn vị tiền tệ là PAB.
CURRENCY_PENEnumĐơn vị tiền tệ từ PEN.
CURRENCY_PHPEnumĐơn vị tiền tệ từ PHP.
CURRENCY_PKREnumĐơn vị tiền tệ là PKR.
CURRENCY_PLNEnumĐơn vị tiền tệ là zloty Ba Lan (PLN).
CURRENCY_RONEnumĐơn vị tiền tệ từ RON.
CURRENCY_RSDEnumĐơn vị tiền tệ từ RSD.
CURRENCY_RUBEnumĐơn vị tiền tệ từ RUB.
CURRENCY_SAREnumĐơn vị tiền tệ từ SAR.
CURRENCY_SEKEnumĐơn vị tiền tệ từ SEK.
CURRENCY_SGDEnumĐơn vị tiền tệ là đô la Singapore.
CURRENCY_THBEnumĐơn vị tiền tệ là baht Thái (THB).
CURRENCY_TRYEnumĐơn vị tiền tệ từ TRY.
CURRENCY_TWDEnumĐơn vị tiền tệ là TWD.
CURRENCY_TZSEnumĐơn vị tiền tệ là shilling Tanzania.
CURRENCY_UAHEnumĐơn vị tiền tệ là UAH.
CURRENCY_USDEnumĐơn vị tiền tệ từ USD.
CURRENCY_UYUEnumĐơn vị tiền tệ từ UYU.
CURRENCY_VEFEnumĐơn vị tiền tệ từ 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ệ từ ZAR.

Fields

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
asArray()Field[]Trả về chế độ xem 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 sử dụng cho tập hợp các trường.
getDefaultMetric()FieldTrả về chỉ số mặc định sẽ được sử 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 sử dụng cho tập hợp các trường.
setDefaultMetric(fieldId)voidĐặt chỉ số mặc định sẽ được sử dụng cho tập hợp các trường.

GetAuthTypeResponse

Phương thức

Phương thứcLoại 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 nội dung đại diện 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ứcLoại 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 bộ lọc đã áp dụng cho trình tạo này.

GetSchemaResponse

Phương thức

Phương thứcLoại 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 nội dung đại diện 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ứcLoại dữ liệu trả vềMô tả ngắn
setId(id)InfoĐặt mã nhận dạng duy nhất cho mục 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ứcLoại dữ liệu trả vềMô tả ngắn
setLabel(label)OptionBuilderĐặt nhãn của trình tạo tuỳ chọn này.
setValue(value)OptionBuilderĐặt giá trị của trình tạo tuỳ chọn này.

SelectMultiple

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
addOption(optionBuilder)SelectMultipleThêm một tuỳ chọn chọn mới.
setAllowOverride(allowOverride)SelectMultipleBật chế độ ghi đè cho mục nhập 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 cấu hình này.
setIsDynamic(isDynamic)SelectMultipleĐặt trạng thái động cho mục nhập cấu hình này.
setName(name)SelectMultipleĐặt tên hiển thị cho mục nhập cấu hình này.

SelectSingle

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
addOption(optionBuilder)SelectSingleThêm một tuỳ chọn chọn mới.
setAllowOverride(allowOverride)SelectSingleBật chế độ ghi đè cho mục nhập 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 cấu hình này.
setIsDynamic(isDynamic)SelectSingleĐặt trạng thái động cho mục nhập cấu hình này.
setName(name)SelectSingleĐặt tên hiển thị cho mục nhập cấu hình này.

SetCredentialsResponse

Phương thức

Phương thứcLoại 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 nội dung đại diện 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ứcLoại dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)TextAreaBật chế độ ghi đè cho mục nhập 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 cấu hình này.
setIsDynamic(isDynamic)TextAreaĐặt trạng thái động cho mục nhập cấu hình này.
setName(name)TextAreaĐặt tên hiển thị cho mục nhập cấu hình này.
setPlaceholder(placeholder)TextAreaĐặt văn bản giữ chỗ cho mục nhập cấu hình này.

TextInput

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)TextInputBật chế độ ghi đè cho mục nhập 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 cấu hình này.
setIsDynamic(isDynamic)TextInputĐặt trạng thái động cho mục nhập cấu hình này.
setName(name)TextInputĐặt tên hiển thị cho mục nhập cấu hình này.
setPlaceholder(placeholder)TextInputĐặt văn bản giữ chỗ cho mục nhập cấu hình này.

UserError

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
printJson()StringIn nội dung đại diện 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 xem được.
setText(text)UserErrorĐặt văn bản của lỗi người dùng.
throwException()voidKích hoạt trường hợp ngoại lệ này.