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	Auto、

AuthType

プロパティ

プロパティ	種類	説明
NONE	Enum	承認は必要ありません。
OAUTH2	Enum	OAuth2 認証が必要です。
USER_PASS	Enum	ユーザー名とパスワードの認証情報が必要です。
PATH_USER_PASS	Enum	ユーザー名、パス、パスワードが必要です。
PATH_KEY	Enum	パスとキーが必要です。
KEY	Enum	API キーまたはトークンが必要です。
USER_TOKEN	Enum	ユーザー名とパスワードが必要です。

BigQueryConfig

Methods

メソッド	戻り値の型	概要
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 とレガシー SQL のどちらとして解釈するかを決定します。

BigQueryParameterType

プロパティ

プロパティ	種類	説明
STRING	Enum	文字列。
INT64	Enum	64 ビットの整数。
BOOL	Enum	Boolean 型。
FLOAT64	Enum	64 ビット浮動小数点数。

Checkbox

Methods

メソッド	戻り値の型	概要
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 列挙型。

Methods

メソッド	戻り値の型	概要
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

Methods

メソッド	戻り値の型	概要
build()	Object	このオブジェクトを検証し、データポータルに必要な形式で返します。
newCheckbox()	Checkbox	新しいチェックボックス構成エントリを返します。
newInfo()	Info	新しい info 構成エントリを返します。
newOptionBuilder()	OptionBuilder	新しいオプション ビルダーを返します。
newSelectMultiple()	SelectMultiple	新しい複数選択構成エントリを返します。
newSelectSingle()	SelectSingle	新しい 1 つの構成エントリを選択します。
newTextArea()	TextArea	新しいテキスト領域設定エントリを返します。
newTextInput()	TextInput	新しいテキスト入力構成エントリを返します。
printJson()	String	このオブジェクトの JSON 表現を出力します。
setDateRangeRequired(dateRangeRequired)	Config	true の場合、getData() リクエストの期間を指定します。
setIsSteppedConfig(isSteppedConfig)	Config	true の場合、現在のユーザー構成で getConfig() が再度呼び出されます。

DataStudioApp

Methods

メソッド	戻り値の型	概要
createCommunityConnector()	CommunityConnector	新しいコミュニティ コネクタを作成します。

DebugError

Methods

メソッド	戻り値の型	概要
printJson()	String	このオブジェクトの JSON 表現を出力します。
setText(text)	DebugError	管理者にのみ表示されます。
throwException()	void	この例外のスローをトリガーします。

Field

Methods

メソッド	戻り値の型	概要
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 は日曜日を表す [0,6] の範囲の数値。
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	Mountain View などの都市。
CITY_CODE	Enum	1014044 などの都市コード。
METRO	Enum	地下鉄（サンフランシスコ - オークランド - サンノゼ、カリフォルニアなど）
METRO_CODE	Enum	200807 などの大都市圏コード。
LATITUDE_LONGITUDE	Enum	緯度と経度のペア（例: 51.5074、-0.1278）。
NUMBER	Enum	10 進数。
PERCENT	Enum	小数での割合（1.0 より大きくすることもできます）。
TEXT	Enum	自由形式のテキスト。
BOOLEAN	Enum	true または false のブール値。
URL	Enum	テキスト形式の URL（https://google.com など）。
HYPERLINK	Enum	ハイパーリンク。
IMAGE	Enum	画像。
IMAGE_LINK	Enum	商品画像リンクです。
CURRENCY_AED	Enum	AED の通貨。
CURRENCY_ALL	Enum	すべての通貨。
CURRENCY_ARS	Enum	アルゼンチン ペソでの通貨。
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	通貨は人民元です。
CURRENCY_COP	Enum	COP の通貨。
CURRENCY_CRC	Enum	CRC の通貨。
CURRENCY_CZK	Enum	チェココルナの通貨。
CURRENCY_DKK	Enum	デンマーク クローネの通貨。
CURRENCY_DOP	Enum	DOP の通貨。
CURRENCY_EGP	Enum	EGP の通貨。
CURRENCY_ETB	Enum	ETB の通貨。
CURRENCY_EUR	Enum	ユーロ（EUR）の通貨。
CURRENCY_GBP	Enum	英ポンドの通貨。
CURRENCY_HKD	Enum	香港ドルの通貨。
CURRENCY_HRK	Enum	HRK の通貨。
CURRENCY_HUF	Enum	通貨は HUF です。
CURRENCY_IDR	Enum	IDR の通貨。
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	スリランカ ルピーの通貨。
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	ノルウェー クローネの通貨。
CURRENCY_NZD	Enum	ニュージーランド ドルの通貨。
CURRENCY_PAB	Enum	PAB の通貨。
CURRENCY_PEN	Enum	ペルーソルで換算した通貨。
CURRENCY_PHP	Enum	PHP の通貨。
CURRENCY_PKR	Enum	パキスタン リヤルの通貨。
CURRENCY_PLN	Enum	ポーランド ズウォティの通貨。
CURRENCY_RON	Enum	RON の通貨。
CURRENCY_RSD	Enum	RSD の通貨。
CURRENCY_RUB	Enum	RUB の通貨。
CURRENCY_SAR	Enum	サウジリヤル（SAR）の通貨。
CURRENCY_SEK	Enum	スウェーデン クローネの通貨。
CURRENCY_SGD	Enum	シンガポール ドルの通貨。
CURRENCY_THB	Enum	タイバーツの通貨。
CURRENCY_TRY	Enum	トルコリラの通貨。
CURRENCY_TWD	Enum	台湾ドルの通貨。
CURRENCY_TZS	Enum	TZS の通貨。
CURRENCY_UAH	Enum	UAH の通貨。
CURRENCY_USD	Enum	米ドルの通貨。
CURRENCY_UYU	Enum	UYU の通貨。
CURRENCY_VEF	Enum	VEF の通貨。
CURRENCY_VND	Enum	VND の通貨。
CURRENCY_YER	Enum	YER の通貨。
CURRENCY_ZAR	Enum	ZAR の通貨。

Fields

Methods

メソッド	戻り値の型	概要
asArray()	Field[]	このオブジェクトのビューを配列として返します。
build()	Object[]	このオブジェクトを検証し、データポータルに必要な形式で返します。
forIds(ids)	Fields	フィルタされ、ID が ids の 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

Methods

メソッド	戻り値の型	概要
build()	Object	このオブジェクトを検証し、データポータルに必要な形式で返します。
printJson()	String	このオブジェクトの JSON 表現を出力します。
setAuthType(authType)	GetAuthTypeResponse	ビルダーの AuthType を設定します。
setHelpUrl(helpUrl)	GetAuthTypeResponse	ビルダーのヘルプ URL を設定します。

GetDataResponse

Methods

メソッド	戻り値の型	概要
addAllRows(rows)	GetDataResponse	この GetDataResponse に複数のデータ行を追加します。
addRow(row)	GetDataResponse	この GetDataResponse にデータ行を追加します。
build()	Object	このオブジェクトを検証し、データポータルに必要な形式で返します。
setFields(fields)	GetDataResponse	ビルダーの Fields を設定します。
setFiltersApplied(filtersApplied)	GetDataResponse	このビルダーのフィルタ適用ステータスを設定します。

GetSchemaResponse

Methods

メソッド	戻り値の型	概要
build()	Object	このオブジェクトを検証し、データポータルに必要な形式で返します。
printJson()	String	このオブジェクトの JSON 表現を出力します。
setFields(fields)	GetSchemaResponse	ビルダーの Fields を設定します。

Info

Methods

メソッド	戻り値の型	概要
setId(id)	Info	この構成エントリに一意の ID を設定します。
setText(text)	Info	この構成エントリのテキストを設定します。

OptionBuilder

Methods

メソッド	戻り値の型	概要
setLabel(label)	OptionBuilder	このオプション ビルダーのラベルを設定します。
setValue(value)	OptionBuilder	このオプション ビルダーの値を設定します。

SelectMultiple

Methods

メソッド	戻り値の型	概要
addOption(optionBuilder)	SelectMultiple	新しい選択オプションを追加します。
setAllowOverride(allowOverride)	SelectMultiple	この構成エントリのオーバーライドを有効にします。
setHelpText(helpText)	SelectMultiple	この構成エントリのヘルプテキストを設定します。
setId(id)	SelectMultiple	この構成エントリに一意の ID を設定します。
setIsDynamic(isDynamic)	SelectMultiple	この構成エントリの動的ステータスを設定します。
setName(name)	SelectMultiple	この構成エントリの表示名を設定します。

SelectSingle

Methods

メソッド	戻り値の型	概要
addOption(optionBuilder)	SelectSingle	新しい選択オプションを追加します。
setAllowOverride(allowOverride)	SelectSingle	この構成エントリのオーバーライドを有効にします。
setHelpText(helpText)	SelectSingle	この構成エントリのヘルプテキストを設定します。
setId(id)	SelectSingle	この構成エントリに一意の ID を設定します。
setIsDynamic(isDynamic)	SelectSingle	この構成エントリの動的ステータスを設定します。
setName(name)	SelectSingle	この構成エントリの表示名を設定します。

SetCredentialsResponse

Methods

メソッド	戻り値の型	概要
build()	Object	このオブジェクトを検証し、データポータルに必要な形式で返します。
printJson()	String	このオブジェクトの JSON 表現を出力します。
setIsValid(isValid)	SetCredentialsResponse	この SetCredentialsResponse の有効なステータスを設定します。

TextArea

Methods

メソッド	戻り値の型	概要
setAllowOverride(allowOverride)	TextArea	この構成エントリのオーバーライドを有効にします。
setHelpText(helpText)	TextArea	この構成エントリのヘルプテキストを設定します。
setId(id)	TextArea	この構成エントリに一意の ID を設定します。
setIsDynamic(isDynamic)	TextArea	この構成エントリの動的ステータスを設定します。
setName(name)	TextArea	この構成エントリの表示名を設定します。
setPlaceholder(placeholder)	TextArea	この構成エントリのプレースホルダ テキストを設定します。

TextInput

Methods

メソッド	戻り値の型	概要
setAllowOverride(allowOverride)	TextInput	この構成エントリのオーバーライドを有効にします。
setHelpText(helpText)	TextInput	この構成エントリのヘルプテキストを設定します。
setId(id)	TextInput	この構成エントリに一意の ID を設定します。
setIsDynamic(isDynamic)	TextInput	この構成エントリの動的ステータスを設定します。
setName(name)	TextInput	この構成エントリの表示名を設定します。
setPlaceholder(placeholder)	TextInput	この構成エントリのプレースホルダ テキストを設定します。

UserError

Methods

メソッド	戻り値の型	概要
printJson()	String	このオブジェクトの JSON 表現を出力します。
setDebugText(text)	UserError	管理者にのみ表示されます。
setText(text)	UserError	ユーザーエラーのテキストを設定します。
throwException()	void	この例外のスローをトリガーします。