Data Studio Service

數據分析

這項服務可讓指令碼存取及修改 Data Studio 社群連接器。

類別

名稱	簡短說明
AggregationType	列舉項目，定義可為 Field 設定的匯總類型。
AuthType	定義可為連接器設定的驗證類型的列舉項目。
BigQueryConfig	原生 BigQuery 連接器的設定物件。
BigQueryParameterType	定義可設定的 BigQuery 參數類型的列舉。
Checkbox	包含設定檔的核取方塊資訊。
CommunityConnector	社群連接器可讓指令碼存取建構工具和公用程式，協助開發適用於數據分析的社群連接器。
Config	包含連接器的設定項目。
DataStudioApp	數據工作室應用程式可讓指令碼與數據分析的開發人員導向功能互動。
DebugError	只有連接器管理員看得到的錯誤。
Field	包含欄位相關資料。
FieldType	列舉定義可為 Field 設定的類型。
Fields	包含社群連接器的 Field 組合。
GetAuthTypeResponse	建構工具，可為指令碼專案建立 getAuthType() 回應。
GetDataResponse	建構工具，可為指令碼專案建立 getData() 回應。
GetSchemaResponse	建構工具，可為指令碼專案建立 getSchema() 回應。
Info	包含設定檔的資訊資料。
OptionBuilder	用於建立 SelectSingle 和 SelectMultiple 選項的建構工具。
SelectMultiple	包含選取的多項設定資訊。
SelectSingle	包含所選設定的單一資訊。
SetCredentialsResponse	建構工具，可為指令碼專案建立 setCredentials() 回應。
TextArea	包含設定檔的文字區域資訊。
TextInput	包含設定檔的文字輸入資訊。
UserError	向連接器使用者顯示的錯誤。

AggregationType

屬性

屬性	類型	說明
AVG	Enum	平均。
COUNT	Enum	計數。
COUNT_DISTINCT	Enum	不重複值的計數。
MAX	Enum	最新
MIN	Enum	最舊
SUM	Enum	總和。
AUTO	Enum	自動。

AuthType

屬性

屬性	類型	說明
NONE	Enum	無須授權。
OAUTH2	Enum	需要 OAuth2 授權。
USER_PASS	Enum	需要使用者名稱和密碼憑證。
PATH_USER_PASS	Enum	需要使用者名稱、路徑和密碼。
PATH_KEY	Enum	需要路徑和金鑰。
KEY	Enum	需要 API 金鑰或權杖。
USER_TOKEN	Enum	需要使用者名稱和符記。

BigQueryConfig

方法

方法	傳回類型	簡短說明
addQueryParameter(name, type, value)	BigQueryConfig	將查詢參數新增至此 BigQueryConfig。
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
printJson()	String	列印此物件的 JSON 表示法。
setAccessToken(accessToken)	BigQueryConfig	設定此 BigQueryConfig 的存取權杖。
setBillingProjectId(billingProjectId)	BigQueryConfig	設定這個 BigQueryConfig 的報帳專案 ID。
setQuery(query)	BigQueryConfig	設定此 BigQueryConfig 的 SQL 查詢。
setUseStandardSql(useStandardSql)	BigQueryConfig	判斷查詢是否會解讀為標準或舊版 SQL。

BigQueryParameterType

屬性

屬性	類型	說明
STRING	Enum	字串。
INT64	Enum	64 位元整數。
BOOL	Enum	Boolean 值。
FLOAT64	Enum	64 位元浮點數。

Checkbox

方法

方法	傳回類型	簡短說明
setAllowOverride(allowOverride)	Checkbox	啟用此設定項目的覆寫功能。
setHelpText(helpText)	Checkbox	設定此設定項目的說明文字。
setId(id)	Checkbox	設定此設定項目的專屬 ID。
setIsDynamic(isDynamic)	Checkbox	設定這項設定項目的動態狀態。
setName(name)	Checkbox	設定這個設定項目的顯示名稱。

CommunityConnector

屬性

屬性	類型	說明
AggregationType	AggregationType	AggregationType 列舉。
AuthType	AuthType	AuthType 列舉。
BigQueryParameterType	BigQueryParameterType	BigQueryParameterType 列舉。
FieldType	FieldType	FieldType 列舉。

方法

方法	傳回類型	簡短說明
getConfig()	Config	傳回 Config 物件。
getFields()	Fields	傳回 Fields 物件。
newAuthTypeResponse()	GetAuthTypeResponse	傳回新的 GetAuthTypeResponse 物件。
newBigQueryConfig()	BigQueryConfig	傳回新的 BigQueryConfig 物件。
newDebugError()	DebugError	傳回新的 DebugError 物件。
newGetDataResponse()	GetDataResponse	傳回新的 GetDataResponse 物件。
newGetSchemaResponse()	GetSchemaResponse	傳回新的 GetSchemaResponse 物件。
newSetCredentialsResponse()	SetCredentialsResponse	傳回新的 SetCredentialsResponse 物件。
newUserError()	UserError	傳回新的 UserError 物件。

Config

方法

方法	傳回類型	簡短說明
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
newCheckbox()	Checkbox	傳回新的核取方塊設定項目。
newInfo()	Info	傳回新的資訊設定項目。
newOptionBuilder()	OptionBuilder	傳回新的選項建構工具。
newSelectMultiple()	SelectMultiple	傳回新的選取多個設定項目。
newSelectSingle()	SelectSingle	回傳新的選取單一設定項目。
newTextArea()	TextArea	傳回新的文字區域設定項目。
newTextInput()	TextInput	傳回新的文字輸入設定項目。
printJson()	String	列印此物件的 JSON 表示法。
setDateRangeRequired(dateRangeRequired)	Config	如果為 true，則會為 getData() 要求提供日期範圍。
setIsSteppedConfig(isSteppedConfig)	Config	如果是 true，系統會再次以目前使用者設定呼叫 getConfig()。

DataStudioApp

方法

方法	傳回類型	簡短說明
createCommunityConnector()	CommunityConnector	建立新的社群連接器。

DebugError

方法

方法	傳回類型	簡短說明
printJson()	String	列印此物件的 JSON 表示法。
setText(text)	DebugError	設定偵錯錯誤的文字，只會顯示給管理員。
throwException()	void	觸發這個例外狀況。

Field

方法

方法	傳回類型	簡短說明
getAggregation()	AggregationType	傳回此 Field 的 AggregationType。
getDescription()	String	傳回此 Field 的說明。
getFormula()	String	傳回此 Field 的公式。
getGroup()	String	傳回這個 Field 的群組。
getId()	String	傳回此 Field 的 ID。
getIsReaggregatable()	Boolean	如果這個欄位可重新匯總，就會傳回 true，否則傳回 false。
getName()	String	傳回此 Field 的名稱。
getType()	FieldType	傳回此 Field 的 FieldType。
isDefault()	Boolean	如果這個 Field 是預設指標或維度，就會傳回 true。
isDimension()	Boolean	如果這個欄位是維度，則傳回 true。
isHidden()	Boolean	如果這個 Field 是隱藏的，則會傳回 true。
isMetric()	Boolean	如果這個欄位是指標，則會傳回 true。
setAggregation(aggregation)	Field	設定這個 Field 的匯總類型。
setDescription(description)	Field	設定此 Field 的說明。
setFormula(formula)	Field	設定此 Field 的公式。
setGroup(group)	Field	設定此 Field 的群組。
setId(id)	Field	設定此 Field 的 ID。
setIsHidden(isHidden)	Field	設定此 Field 的隱藏狀態。
setIsReaggregatable(isReaggregatable)	Field	設定 Field 的重新匯總許可狀態。
setName(name)	Field	設定此 Field 的名稱。
setType(type)	Field	設定此 Field 的 FieldType。

FieldType

屬性

屬性	類型	說明
YEAR	Enum	年份，格式為 YYYY，例如 2017。
YEAR_QUARTER	Enum	年份和季度，格式為 YYYYQ，例如 20171。
YEAR_MONTH	Enum	年和月格式為 YYYYMM，例如 201703。
YEAR_WEEK	Enum	年份和週數，格式為 YYYYww，例如 201707。
YEAR_MONTH_DAY	Enum	年、月和日，格式為 YYYYMMDD，例如 20170317。
YEAR_MONTH_DAY_HOUR	Enum	年、月、日和時，格式為 YYYYMMDDHH，例如 2017031703。
YEAR_MONTH_DAY_MINUTE	Enum	年、月、日、時和分，格式為 YYYYMMDDHHmm，例如 201703170230。
YEAR_MONTH_DAY_SECOND	Enum	年、月、日、時、分和秒，格式為 YYYYMMDDHHmmss，例如 20170317023017。
QUARTER	Enum	季度 (格式為 1、2、3 或 4)。
MONTH	Enum	月份格式為 MM，例如 03。
WEEK	Enum	以 ww 格式表示的星期，例如 07。
MONTH_DAY	Enum	以 MMDD 格式輸入月份和日期，例如 0317。
DAY_OF_WEEK	Enum	範圍為 [0,6] 的數字，0 代表星期日。
DAY	Enum	以 DD 格式顯示的日期，例如 17。
HOUR	Enum	以 HH 格式表示小時，例如 13。
MINUTE	Enum	分鐘，格式為 mm，例如 12。
DURATION	Enum	時間長度，以秒為單位。
COUNTRY	Enum	國家/地區，例如美國。
COUNTRY_CODE	Enum	國家/地區代碼，例如 US。
CONTINENT	Enum	洲，例如美洲。
CONTINENT_CODE	Enum	洲別代碼，例如 019。
SUB_CONTINENT	Enum	次大陸，例如北美洲。
SUB_CONTINENT_CODE	Enum	次大陸代碼，例如 003。
REGION	Enum	例如加州。
REGION_CODE	Enum	區域代碼，例如 CA。
CITY	Enum	城市，例如山景城。
CITY_CODE	Enum	城市代碼，例如 1014044。
METRO	Enum	大都會區，例如加州舊金山-奧克蘭-聖荷西。
METRO_CODE	Enum	都會區代碼，例如 200807。
LATITUDE_LONGITUDE	Enum	經緯度組合，例如 51.5074, -0.1278。
NUMBER	Enum	小數。
PERCENT	Enum	小數位數百分比 (可超過 1.0)。
TEXT	Enum	任意形式文字。
BOOLEAN	Enum	true 或 false 布林值。
URL	Enum	網址文字，例如 https://google.com。
HYPERLINK	Enum	超連結。
IMAGE	Enum	圖片。
IMAGE_LINK	Enum	圖片連結。
CURRENCY_AED	Enum	貨幣為阿聯迪拉姆。
CURRENCY_ALL	Enum	來自「全部」的貨幣。
CURRENCY_ARS	Enum	貨幣為阿根廷披索。
CURRENCY_AUD	Enum	貨幣為澳幣。
CURRENCY_BDT	Enum	孟加拉塔卡。
CURRENCY_BGN	Enum	貨幣為 BGN。
CURRENCY_BOB	Enum	由 BOB 提供的貨幣。
CURRENCY_BRL	Enum	幣別為巴西雷亞爾。
CURRENCY_CAD	Enum	幣別為加幣。
CURRENCY_CDF	Enum	CDF 貨幣。
CURRENCY_CHF	Enum	貨幣為瑞士法郎。
CURRENCY_CLP	Enum	貨幣為新臺幣。
CURRENCY_CNY	Enum	貨幣為人民幣。
CURRENCY_COP	Enum	貨幣為哥倫比亞披索。
CURRENCY_CRC	Enum	貨幣為 CRC。
CURRENCY_CZK	Enum	貨幣為捷克克朗 (CZK)。
CURRENCY_DKK	Enum	貨幣為丹麥克朗。
CURRENCY_DOP	Enum	DOP 幣別。
CURRENCY_EGP	Enum	貨幣單位為埃及鎊。
CURRENCY_ETB	Enum	貨幣為 ETB。
CURRENCY_EUR	Enum	貨幣為歐元。
CURRENCY_GBP	Enum	貨幣為英鎊。
CURRENCY_HKD	Enum	貨幣為港幣。
CURRENCY_HRK	Enum	貨幣為 HRK。
CURRENCY_HUF	Enum	貨幣為 HUF。
CURRENCY_IDR	Enum	貨幣為印尼盾。
CURRENCY_ILS	Enum	以 ILS 為單位的貨幣。
CURRENCY_INR	Enum	貨幣為印度盧比 (INR)。
CURRENCY_IRR	Enum	來自 IRR 的貨幣。
CURRENCY_ISK	Enum	貨幣為冰島克朗。
CURRENCY_JMD	Enum	貨幣為 JMD。
CURRENCY_JPY	Enum	貨幣為日圓。
CURRENCY_KRW	Enum	貨幣為韓元。
CURRENCY_LKR	Enum	貨幣為 LKR。
CURRENCY_LTL	Enum	來自 LTL 的幣別。
CURRENCY_MNT	Enum	MNT 貨幣。
CURRENCY_MVR	Enum	來自 MVR 的貨幣。
CURRENCY_MXN	Enum	貨幣為 MXN。
CURRENCY_MYR	Enum	貨幣為馬來西亞幣。
CURRENCY_NGN	Enum	幣別為奈拉。
CURRENCY_NOK	Enum	來自挪威克朗的貨幣。
CURRENCY_NZD	Enum	貨幣為紐西蘭幣。
CURRENCY_PAB	Enum	貨幣為 PAB。
CURRENCY_PEN	Enum	使用 PEN 的幣別。
CURRENCY_PHP	Enum	來自 PHP 的貨幣。
CURRENCY_PKR	Enum	PKR 的貨幣。
CURRENCY_PLN	Enum	貨幣為波蘭茲羅提。
CURRENCY_RON	Enum	貨幣為 RON。
CURRENCY_RSD	Enum	來自 RSD 的貨幣。
CURRENCY_RUB	Enum	貨幣為俄羅斯盧布。
CURRENCY_SAR	Enum	幣別為沙烏地里亞爾。
CURRENCY_SEK	Enum	貨幣為瑞典克朗。
CURRENCY_SGD	Enum	貨幣為新加坡元。
CURRENCY_THB	Enum	貨幣為泰銖。
CURRENCY_TRY	Enum	幣別為 TRY。
CURRENCY_TWD	Enum	貨幣為新臺幣。
CURRENCY_TZS	Enum	幣別為坦尚尼亞先令。
CURRENCY_UAH	Enum	貨幣為 UAH。
CURRENCY_USD	Enum	貨幣為美元。
CURRENCY_UYU	Enum	來自 UYU 的貨幣。
CURRENCY_VEF	Enum	幣別為 VEF。
CURRENCY_VND	Enum	貨幣為越南盾。
CURRENCY_YER	Enum	YER 幣別。
CURRENCY_ZAR	Enum	貨幣為南非蘭特。

Fields

方法

方法	傳回類型	簡短說明
asArray()	Field[]	以陣列形式傳回此物件的檢視畫面。
build()	Object[]	驗證這個物件，並以 Data Studio 所需的格式傳回。
forIds(ids)	Fields	傳回新的 Fields 物件，篩選出 ID 位於 ids 中的 Field。
getDefaultDimension()	Field	傳回要用於一組欄位的預設維度。
getDefaultMetric()	Field	傳回要用於一組欄位的預設指標。
getFieldById(fieldId)	Field	傳回具有指定 ID 的欄位，如果這個 Fields 物件中沒有該 ID 的欄位，則傳回 null。
newDimension()	Field	傳回新的維度 Field。
newMetric()	Field	傳回新的指標 Field。
setDefaultDimension(fieldId)	void	設定要用於一組欄位的預設維度。
setDefaultMetric(fieldId)	void	設定要用於一組欄位的預設指標。

GetAuthTypeResponse

方法

方法	傳回類型	簡短說明
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
printJson()	String	列印此物件的 JSON 表示法。
setAuthType(authType)	GetAuthTypeResponse	設定建構工具的 AuthType。
setHelpUrl(helpUrl)	GetAuthTypeResponse	設定建構工具的說明網址。

GetDataResponse

方法

方法	傳回類型	簡短說明
addAllRows(rows)	GetDataResponse	將多列資料新增至此 GetDataResponse。
addRow(row)	GetDataResponse	將資料列新增至此 GetDataResponse。
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
setFields(fields)	GetDataResponse	設定建構工具的 Fields。
setFiltersApplied(filtersApplied)	GetDataResponse	設定這個建構工具套用的篩選器狀態。

GetSchemaResponse

方法

方法	傳回類型	簡短說明
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
printJson()	String	列印此物件的 JSON 表示法。
setFields(fields)	GetSchemaResponse	設定建構工具的 Fields。

Info

方法

方法	傳回類型	簡短說明
setId(id)	Info	設定此設定項目的專屬 ID。
setText(text)	Info	設定此設定項目的文字。

OptionBuilder

方法

方法	傳回類型	簡短說明
setLabel(label)	OptionBuilder	設定這個選項建構工具的標籤。
setValue(value)	OptionBuilder	設定這個選項建構工具的值。

SelectMultiple

方法

方法	傳回類型	簡短說明
addOption(optionBuilder)	SelectMultiple	新增選取選項。
setAllowOverride(allowOverride)	SelectMultiple	啟用此設定項目的覆寫功能。
setHelpText(helpText)	SelectMultiple	設定此設定項目的說明文字。
setId(id)	SelectMultiple	設定此設定項目的專屬 ID。
setIsDynamic(isDynamic)	SelectMultiple	設定這項設定項目的動態狀態。
setName(name)	SelectMultiple	設定這個設定項目的顯示名稱。

SelectSingle

方法

方法	傳回類型	簡短說明
addOption(optionBuilder)	SelectSingle	新增選取選項。
setAllowOverride(allowOverride)	SelectSingle	啟用此設定項目的覆寫功能。
setHelpText(helpText)	SelectSingle	設定此設定項目的說明文字。
setId(id)	SelectSingle	設定此設定項目的專屬 ID。
setIsDynamic(isDynamic)	SelectSingle	設定這項設定項目的動態狀態。
setName(name)	SelectSingle	設定這個設定項目的顯示名稱。

SetCredentialsResponse

方法

方法	傳回類型	簡短說明
build()	Object	驗證這個物件，並以 Data Studio 所需的格式傳回。
printJson()	String	列印此物件的 JSON 表示法。
setIsValid(isValid)	SetCredentialsResponse	設定此 SetCredentialsResponse 的有效狀態。

TextArea

方法

方法	傳回類型	簡短說明
setAllowOverride(allowOverride)	TextArea	啟用此設定項目的覆寫功能。
setHelpText(helpText)	TextArea	設定此設定項目的說明文字。
setId(id)	TextArea	設定此設定項目的專屬 ID。
setIsDynamic(isDynamic)	TextArea	設定這項設定項目的動態狀態。
setName(name)	TextArea	設定這個設定項目的顯示名稱。
setPlaceholder(placeholder)	TextArea	設定此設定項目的預留位置文字。

TextInput

方法

方法	傳回類型	簡短說明
setAllowOverride(allowOverride)	TextInput	啟用此設定項目的覆寫功能。
setHelpText(helpText)	TextInput	設定此設定項目的說明文字。
setId(id)	TextInput	設定此設定項目的專屬 ID。
setIsDynamic(isDynamic)	TextInput	設定這項設定項目的動態狀態。
setName(name)	TextInput	設定這個設定項目的顯示名稱。
setPlaceholder(placeholder)	TextInput	設定此設定項目的預留位置文字。

UserError

方法

方法	傳回類型	簡短說明
printJson()	String	列印此物件的 JSON 表示法。
setDebugText(text)	UserError	設定偵錯錯誤的文字，只會顯示給管理員。
setText(text)	UserError	設定使用者錯誤的文字。
throwException()	void	觸發這個例外狀況。