Data Studio Service

Data Studio

Dịch vụ này cho phép các 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 kiểu tổng hợp có thể được đặt cho Field.
AuthTypeMột giá trị enum xác định các loại xác thực có thể thiết lập 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 giá trị enum xác định các loại tham số BigQuery mà bạn có thể đặt.
CheckboxChứa thông tin hộp đánh dấu cho cấu hình.
CommunityConnectorCộng đồng kết nối cho phép tập lệnh truy cập vào các trình tạo và tiện ích để giúp 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 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 trong Data Studio.
DebugErrorLỗi chỉ hiển thị với quản trị viên của trình kết nối.
FieldChứa dữ liệu liên quan đến trường.
FieldTypeMột giá trị enum xác định các kiểu có thể đặt cho một Field.
FieldsChứa một bộ Field dành 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 tuỳ chọn cho SelectSingleSelectMultiple.
SelectMultipleChứa nhiều thông tin chọn lọc cho cấu hình.
SelectSingleChứa một số thông tin chọn lọc 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ù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ị với người dùng của trình kết nối.

AggregationType

Thuộc tính

Tài sảnLoạiNội dung mô tả
AVGEnumTrung bình.
COUNTEnumCách tính.
COUNT_DISTINCTEnumSố lượng có tính chất riêng biệt
MAXEnum% CPC
MINEnumTối thiểu
SUMEnumTổng
AUTOEnumTự động.

AuthType

Thuộc tính

Tài sảnLoạiNội dung mô tả
NONEEnumKhông cần uỷ quyền.
OAUTH2EnumCần uỷ quyền OAuth2.
USER_PASSEnumCần có thông tin đăng nhập bằng 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_KEYEnumĐường dẫn và khoá cần thiết.
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ứcKiểu dữ liệu trả vềMô tả ngắn
addQueryParameter(name, type, value)BigQueryConfigThêm tham số truy vấn vào BigQueryConfig này.
build()ObjectXác thực đối tượng này và trả về ở định dạng mà Data Studio cần.
printJson()StringIn đại diện JSON của đối tượng này.
setAccessToken(accessToken)BigQueryConfigThiết lập 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

Tài sảnLoạiNội dung mô tả
STRINGEnumChuỗi.
INT64EnumSố nguyên 64 bit.
BOOLEnumBoolean.
FLOAT64EnumSố thự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)CheckboxBật tính năng ghi đè cho mục cấu hình này.
setHelpText(helpText)CheckboxĐặt văn bản trợ giúp cho mục 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 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

Tài sảnLoạiNội dung mô 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ề đối tượng Config.
getFields()FieldsTrả về đối tượng Fields.
newAuthTypeResponse()GetAuthTypeResponseTrả về đối tượng GetAuthTypeResponse mới.
newBigQueryConfig()BigQueryConfigTrả về đối tượng BigQueryConfig mới.
newDebugError()DebugErrorTrả về đối tượng DebugError mới.
newGetDataResponse()GetDataResponseTrả về đối tượng GetDataResponse mới.
newGetSchemaResponse()GetSchemaResponseTrả về đối tượng GetSchemaResponse mới.
newSetCredentialsResponse()SetCredentialsResponseTrả về đối tượng SetCredentialsResponse mới.
newUserError()UserErrorTrả về đố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ề ở định dạng mà Data Studio cần.
newCheckbox()CheckboxTrả về một mục nhập 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ề trình tạo tuỳ chọn mới.
newSelectMultiple()SelectMultipleTrả về một mục nhập cấu hình mới có nhiều lựa chọn.
newSelectSingle()SelectSingleTrả về một mục nhập cấu hình mới được chọn và duy nhất.
newTextArea()TextAreaTrả về một mục nhập cấu hình mới của vùng văn bản.
newTextInput()TextInputTrả về một mục nhập cấu hình nhập văn bản mới.
printJson()StringIn đại diện JSON của đối tượng này.
setDateRangeRequired(dateRangeRequired)ConfigNếu là true, hệ thống sẽ cung cấp một phạm vi ngày 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ứcKiểu dữ liệu trả vềMô tả ngắn
createCommunityConnector()CommunityConnectorTạo 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 đại diện JSON của đối tượng này.
setText(text)DebugErrorĐặt nội dung của lỗi gỡ lỗi (chỉ hiển thị cho quản trị viên).
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 trường này có thể tổng hợp lại được, 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 của Field này.
setGroup(group)FieldThiết lập nhóm của Field này.
setId(id)FieldThiết lập mã nhận dạng của Field này.
setIsHidden(isHidden)FieldThiết lập 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 Field.
setName(name)FieldĐặt tên cho Field này.
setType(type)FieldThiết lập FieldType của Field này.

FieldType

Thuộc tính

Tài sảnLoạiNội dung mô 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 YYYYwww, 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 ở đị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 theo định dạng YYYYMMDDHHmmss, chẳng hạn như 20170317023017.
QUARTEREnumQuý theo đị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 ở định dạng MMDD, chẳng hạn như 0317.
DAY_OF_WEEKEnumMột số trong khoảng [0,6] với 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.
DURATIONEnumKhoảng thời gian tính bằng giây.
COUNTRYEnumMột quốc gia 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ã châu lục, 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 thành phố lớn như San Francisco-Oakland-San Jose CA.
METRO_CODEEnumMã thành phố lớn như 200807.
LATITUDE_LONGITUDEEnumCặp kinh độ vĩ độ, chẳng hạn như 51.5074, -0.1278.
NUMBEREnumSố thập phân.
PERCENTEnumPhầ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 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ệ từ AED.
CURRENCY_ALLEnumĐơn vị tiền tệ từ TẤT CẢ.
CURRENCY_ARSEnumĐơn vị tiền tệ từ ARS.
CURRENCY_AUDEnumĐơn vị tiền tệ từ AUD.
CURRENCY_BDTEnumĐơn vị tiền tệ từ BDT.
CURRENCY_BGNEnumĐơn vị tiền tệ từ BGN.
CURRENCY_BOBEnumĐơn vị tiền tệ từ BOB.
CURRENCY_BRLEnumĐơn vị tiền tệ từ BRL.
CURRENCY_CADEnumĐơn vị tiền tệ từ 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ệ từ COP.
CURRENCY_CRCEnumĐơn vị tiền tệ từ 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ệ từ DOP.
CURRENCY_EGPEnumĐơn vị tiền tệ từ EGP.
CURRENCY_ETBEnumĐơn vị tiền tệ từ ETB.
CURRENCY_EUREnumĐơn vị tiền tệ từ EUR.
CURRENCY_GBPEnumĐơn vị tiền tệ từ GBP.
CURRENCY_HKDEnumĐơn vị tiền tệ từ HKD.
CURRENCY_HRKEnumĐơn vị tiền tệ từ HRK.
CURRENCY_HUFEnumĐơn vị tiền tệ từ HUF.
CURRENCY_IDREnumĐơn vị tiền tệ từ rupiah Indonesia.
CURRENCY_ILSEnumĐơn vị tiền tệ từ ILS.
CURRENCY_INREnumĐơn vị tiền tệ từ INR.
CURRENCY_IRREnumĐơn vị tiền tệ từ IRR.
CURRENCY_ISKEnumĐơn vị tiền tệ từ ISK.
CURRENCY_JMDEnumĐơn vị tiền tệ từ JMD.
CURRENCY_JPYEnumĐơn vị tiền tệ từ 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ệ từ LTL.
CURRENCY_MNTEnumĐơn vị tiền tệ từ MNT.
CURRENCY_MVREnumĐơn vị tiền tệ từ MVR.
CURRENCY_MXNEnumĐơn vị tiền tệ từ MXN.
CURRENCY_MYREnumĐơn vị tiền tệ từ MYR.
CURRENCY_NGNEnumĐơn vị tiền tệ từ NGN.
CURRENCY_NOKEnumĐơn vị tiền tệ từ NOK.
CURRENCY_NZDEnumĐơn vị tiền tệ từ NZD.
CURRENCY_PABEnumĐơn vị tiền tệ từ 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ệ từ PKR.
CURRENCY_PLNEnumĐơn vị tiền tệ từ 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ệ từ SGD.
CURRENCY_THBEnumĐơn vị tiền tệ từ THB.
CURRENCY_TRYEnumĐơn vị tiền tệ từ TRY.
CURRENCY_TWDEnumĐơn vị tiền tệ từ TWD.
CURRENCY_TZSEnumĐơn vị tiền tệ từ TZS.
CURRENCY_UAHEnumĐơn vị tiền tệ từ 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ệ từ đồng Việt Nam.
CURRENCY_YEREnumĐơn vị tiền tệ từ YER.
CURRENCY_ZAREnumĐơn vị tiền tệ từ ZAR.

Fields

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
asArray()Field[]Trả về 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ề ở định dạng mà Data Studio cần.
forIds(ids)FieldsTrả về đối tượng Fields mới được lọc thành các 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ề trường có mã nhận dạng cho trước, 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ề phương diện mới Field.
newMetric()FieldTrả về chỉ số mới Field.
setDefaultDimension(fieldId)voidĐặt phương diện mặc định được sử dụng cho tập hợp các trường.
setDefaultMetric(fieldId)voidĐặt chỉ số mặc định được sử dụng cho tập hợp các 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ề ở định dạng mà Data Studio cần.
printJson()StringIn đạ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ứ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ề ở đị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ề ở định dạng mà Data Studio cần.
printJson()StringIn đạ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ứ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 cấu hình này.
setText(text)InfoĐặt văn bản cho mục 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 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ứcKiểu dữ liệu trả vềMô tả ngắn
addOption(optionBuilder)SelectMultipleThêm tuỳ chọn chọn mới.
setAllowOverride(allowOverride)SelectMultipleBật tính năng ghi đè cho mục cấu hình này.
setHelpText(helpText)SelectMultipleĐặt văn bản trợ giúp cho mục 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 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 tuỳ chọn chọn mới.
setAllowOverride(allowOverride)SelectSingleBật tính năng ghi đè cho mục cấu hình này.
setHelpText(helpText)SelectSingleĐặt văn bản trợ giúp cho mục 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 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ề ở định dạng mà Data Studio cần.
printJson()StringIn đạ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ứcKiểu dữ liệu trả vềMô tả ngắn
setAllowOverride(allowOverride)TextAreaBật tính năng ghi đè cho mục cấu hình này.
setHelpText(helpText)TextAreaĐặt văn bản trợ giúp cho mục 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 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 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)TextInputBật tính năng ghi đè cho mục cấu hình này.
setHelpText(helpText)TextInputĐặt văn bản trợ giúp cho mục 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 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 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 đại diện JSON của đối tượng này.
setDebugText(text)UserErrorĐặt nội dung của lỗi gỡ lỗi (chỉ hiển thị cho quản trị viên).
setText(text)UserErrorĐặt văn bản cho lỗi người dùng.
throwException()voidKích hoạt gửi ngoại lệ này.