Data Studio Service

數據分析

這項服務允許指令碼存取及修改數據分析社群連接器。

類別

名稱	簡短說明
AggregationType	列舉，定義可為 Field 設定的匯總類型。
AuthType	列舉項目，定義可為連接器設定的驗證類型。
BigQueryConfig	原生 BigQuery 連接器的設定物件。
BigQueryParameterType	列舉可定義可設定的 BigQuery 參數類型。
Checkbox	包含設定的核取方塊資訊。
CommunityConnector	CommunityConnector 可讓指令碼存取建構工具和公用程式，協助開發數據分析的社群連接器。
Config	包含連接器的組態項目。
DataStudioApp	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	驗證這個物件，並以數據分析所需的格式傳回。
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	驗證這個物件，並以數據分析所需的格式傳回。
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	年份和週別，以 YYYY 的格式 表示，例如 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	以 www 格式表示的週次，例如 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	例如舊金山-奧克蘭-聖荷西 (San Francisco-Oakland-San Jose CA) 的都會區。
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	AED 的貨幣。
CURRENCY_ALL	Enum	幣別為「ALL」。
CURRENCY_ARS	Enum	ARS 提供的貨幣。
CURRENCY_AUD	Enum	澳幣
CURRENCY_BDT	Enum	BDT 的貨幣。
CURRENCY_BGN	Enum	BGN 提供的貨幣。
CURRENCY_BOB	Enum	BOB 提供的貨幣。
CURRENCY_BRL	Enum	巴西雷亞爾的貨幣。
CURRENCY_CAD	Enum	以加幣計價。
CURRENCY_CDF	Enum	CDF 的貨幣。
CURRENCY_CHF	Enum	瑞士法郎。
CURRENCY_CLP	Enum	CLP 幣別。
CURRENCY_CNY	Enum	CNY 貨幣。
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	以匈牙利福林做為貨幣單位。
CURRENCY_IDR	Enum	印尼盾的貨幣。
CURRENCY_ILS	Enum	貨幣單位：以色列新謝克爾。
CURRENCY_INR	Enum	印度盧比。
CURRENCY_IRR	Enum	IRR 提供的貨幣。
CURRENCY_ISK	Enum	由 ISK 提供的貨幣。
CURRENCY_JMD	Enum	JMD 提供的貨幣。
CURRENCY_JPY	Enum	JPY 的貨幣。
CURRENCY_KRW	Enum	韓元貨幣。
CURRENCY_LKR	Enum	LKR 的貨幣。
CURRENCY_LTL	Enum	LTL 提供的貨幣。
CURRENCY_MNT	Enum	MNT 提供的貨幣。
CURRENCY_MVR	Enum	MVR 提供的貨幣。
CURRENCY_MXN	Enum	貨幣單位：墨西哥披索。
CURRENCY_MYR	Enum	以馬來西亞幣做為貨幣單位。
CURRENCY_NGN	Enum	由 NGN 提供的貨幣。
CURRENCY_NOK	Enum	NOK 的貨幣。
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	羅馬尼亞列伊的貨幣。
CURRENCY_RSD	Enum	RSD 提供的貨幣。
CURRENCY_RUB	Enum	幣別為俄羅斯盧布。
CURRENCY_SAR	Enum	SAR 幣別。
CURRENCY_SEK	Enum	SEK 貨幣。
CURRENCY_SGD	Enum	新加坡幣。
CURRENCY_THB	Enum	由 THB 指定的貨幣。
CURRENCY_TRY	Enum	TRY 幣別。
CURRENCY_TWD	Enum	以台幣計價的貨幣。
CURRENCY_TZS	Enum	TZS 的貨幣。
CURRENCY_UAH	Enum	幣別為烏克蘭荷林夫納。
CURRENCY_USD	Enum	USD 提供的貨幣。
CURRENCY_UYU	Enum	UYU 貨幣。
CURRENCY_VEF	Enum	VEF 的貨幣。
CURRENCY_VND	Enum	越南盾。
CURRENCY_YER	Enum	YER 的貨幣。
CURRENCY_ZAR	Enum	南非蘭特

Fields

方法

方法	傳回類型	簡短說明
asArray()	Field[]	以陣列形式傳回此物件的檢視畫面。
build()	Object[]	驗證這個物件，並以數據分析所需的格式傳回。
forIds(ids)	Fields	傳回篩選為 ids 中 ID 為 Field 的新 Fields 物件。
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	驗證這個物件，並以數據分析所需的格式傳回。
printJson()	String	列印此物件的 JSON 表示法。
setAuthType(authType)	GetAuthTypeResponse	設定建構工具的 AuthType。
setHelpUrl(helpUrl)	GetAuthTypeResponse	設定建構工具的說明網址。

GetDataResponse

方法

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

GetSchemaResponse

方法

方法	傳回類型	簡短說明
build()	Object	驗證這個物件，並以數據分析所需的格式傳回。
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	驗證這個物件，並以數據分析所需的格式傳回。
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	觸發要擲回的例外狀況。