REST Resource: spreadsheets

リソース: スプレッドシート

スプレッドシートを表すリソース。

JSON 表現 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
フィールド
spreadsheetId

string

スプレッドシートの ID。このフィールドは読み取り専用です。
properties

object (SpreadsheetProperties)

スプレッドシートの全体的なプロパティ。
sheets[]

object (Sheet)

スプレッドシートの一部であるシート。
namedRanges[]

object (NamedRange)

スプレッドシートで定義された名前付き範囲。
spreadsheetUrl

string

スプレッドシートの URL。このフィールドは読み取り専用です。
developerMetadata[]

object (DeveloperMetadata)

スプレッドシートに関連付けられたデベロッパーのメタデータ。
dataSources[]

object (DataSource)

スプレッドシートに接続されている外部データソースのリスト。
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

出力専用。データソースの更新スケジュールのリスト。

SpreadsheetProperties

スプレッドシートのプロパティ。

JSON 表現 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
フィールド
title

string

スプレッドシートのタイトル。
locale

string

スプレッドシートの言語 / 地域。次のいずれかの形式で指定します。

  • ISO 639-1 言語コード（en など）

  • 639-1 コードが存在しない場合は、ISO 639-2 言語コード（fil など）

  • ISO 言語コードと国コードの組み合わせ（en_US など）

注: このフィールドを更新する際、すべての言語 / 言語 / 地域がサポートされているわけではありません。
autoRecalc

enum (RecalculationInterval)

揮発性関数が再計算されるまでの待機時間。
timeZone

string

スプレッドシートのタイムゾーン（CLDR 形式、America/New_York など）。タイムゾーンが認識されない場合は、GMT-07:00 などのカスタム タイムゾーンである可能性があります。
defaultFormat

object (CellFormat)

スプレッドシート内のすべてのセルのデフォルトの形式。セルの形式がこのデフォルトの形式と等しい場合、CellData.effectiveFormat は設定されません。このフィールドは読み取り専用です。
iterativeCalculationSettings

object (IterativeCalculationSettings)

反復計算で循環参照を解決するかどうか、およびその方法を決定します。このフィールドがない場合、循環参照により計算エラーが発生します。
spreadsheetTheme

object (SpreadsheetTheme)

スプレッドシートに適用されたテーマ。
importFunctionsExternalUrlAccessAllowed

boolean

画像関数とインポート関数で外部 URL へのアクセスを許可するかどうか。true の場合のみ読み取り専用です。false の場合は、true に設定できます。管理者が許可リスト機能を有効にしている場合、この値は無視され、常に true を返します。

RecalculationInterval

再計算間隔のオプションを列挙します。

列挙型
RECALCULATION_INTERVAL_UNSPECIFIED デフォルト値。この値は使用しないでください。
ON_CHANGE 揮発性関数は、変更のたびに更新されます。
MINUTE 揮発性関数は、変更ごとに、および 1 分ごとに更新されます。
HOUR 揮発性関数は、変更ごとに 1 時間ごとに更新されます。

IterativeCalculationSettings

反復計算で循環依存を解決する方法を制御する設定。

JSON 表現 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
フィールド
maxIterations

integer

反復計算が有効になっている場合、実行する計算ラウンドの最大数。
convergenceThreshold

number

反復計算が有効になっていて、連続する結果の差がこのしきい値未満の場合、計算ラウンドは停止します。

SpreadsheetTheme

スプレッドシートのテーマを表します。

JSON 表現 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
フィールド
primaryFontFamily

string

メインのフォント ファミリーの名前。
themeColors[]

object (ThemeColorPair)

スプレッドシートのテーマの色のペア。更新するには、すべてのテーマカラーペアを指定する必要があります。

ThemeColorPair

スプレッドシートのテーマの色タイプと、その色を表す具体的な色をマッピングしたペア。

JSON 表現 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
フィールド
colorType

enum (ThemeColorType)

スプレッドシートのテーマカラーのタイプ。
color

object (ColorStyle)

テーマのカラータイプに対応する具体的な色。

NamedRange

名前付き範囲。

JSON 表現 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
フィールド
namedRangeId

string

名前付き範囲の ID。
name

string

名前付き範囲の名前。
range

object (GridRange)

範囲を表す値。

DataSource

スプレッドシート内の外部データソースに関する情報。

JSON 表現 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
フィールド
dataSourceId

string

データソースを識別するスプレッドシート スコープの一意の ID。例: 1080547365。
spec

object (DataSourceSpec)

このスプレッドシートに接続されているデータソースの DataSourceSpec。
calculatedColumns[]

object (DataSourceColumn)

データソース内のすべての計算列。
sheetId

integer

データソースに接続されている Sheet の ID。設定したフィールドは変更できません。

データソースを作成するときに、関連する DATA_SOURCE シートも作成されます。このフィールドを指定しない場合は、作成されるシートの ID がランダムに生成されます。

DataSourceSpec

これにより、データソースの詳細を指定します。たとえば、BigQuery の場合は、BigQuery ソースに関する情報を指定します。

JSON 表現 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
フィールド
parameters[]

object (DataSourceParameter)

データソースのパラメータ。データソースのクエリに使用されます。
共用体フィールド spec。データソースの種類ごとの実際の仕様。spec は次のいずれかになります。
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec。
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]。

BigQueryDataSourceSpec

シートに接続されている BigQuery データソースの仕様。

JSON 表現 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
フィールド
projectId

string

請求先アカウントが関連付けられている BigQuery 対応の Google Cloud プロジェクトの ID。データソースに対して実行されたクエリに対して、プロジェクトに料金が発生します。
共用体フィールド spec。実際の仕様。spec は次のいずれかになります。
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec。
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec。

BigQueryQuerySpec

カスタムの BigQuery クエリを指定します。

JSON 表現 
{
  "rawQuery": string
}
フィールド
rawQuery

string

未加工のクエリ文字列。

BigQueryTableSpec

BigQuery テーブル定義を指定します。ネイティブ テーブルのみが許可されます。

JSON 表現 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
フィールド
tableProjectId

string

テーブルが属する BigQuery プロジェクトの ID。指定しない場合は、projectId とみなされます。
tableId

string

BigQuery テーブル ID。
datasetId

string

BigQuery データセット ID。

LookerDataSourceSpec

Looker データソースの仕様。

JSON 表現 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
フィールド
instanceUri

string

Looker インスタンスの URL。
model

string

Looker モデルの名前。
explore

string

Looker モデル Explore の名前。

DataSourceParameter

データソースのクエリ内のパラメータ。このパラメータを使用すると、ユーザーはスプレッドシートからクエリに値を渡すことができます。

JSON 表現 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
フィールド
共用体フィールド identifier。パラメータ ID。identifier は次のいずれかになります。
name

string

名前付きパラメータ。それをサポートする DataSource の正当な識別子である必要があります。たとえば、BigQuery 識別子。
共用体フィールド value。パラメータ値。value は次のいずれかになります。
namedRangeId

string

NamedRange の ID。サイズは 1x1 にする必要があります。
range

object (GridRange)

パラメータの値を含む範囲。サイズは 1x1 にする必要があります。

DataSourceRefreshSchedule

データソースの更新スケジュールを設定します。

スプレッドシート内のデータソースは、一定の間隔で更新されます。開始時間は、スプレッドシート エディタの [スケジュール設定された更新] ボタンをクリックして指定できますが、間隔は 4 時間に固定されています。たとえば、開始時刻を午前 8 時に指定すると、更新は毎日午前 8 時から午後 0 時の間に行われます。

JSON 表現 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
フィールド
enabled

boolean

更新スケジュールが有効になっている場合は true、それ以外の場合は false。
refreshScope

enum (DataSourceRefreshScope)

更新の範囲。ALL_DATA_SOURCES を指定します。
nextRun

object (Interval)

出力専用。次の実行の間隔。
共用体フィールド schedule_config。スケジュール構成 schedule_config は、次のいずれかになります。
dailySchedule

object (DataSourceRefreshDailySchedule)

毎日の更新スケジュール。
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

毎週の更新スケジュール。
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

毎月の更新スケジュール。

DataSourceRefreshScope

データソースの更新スコープ。

列挙型
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED デフォルト値。使用しないでください。
ALL_DATA_SOURCES スプレッドシート内のすべてのデータソースと、それらに関連付けられているデータソース オブジェクトを更新します。

DataSourceRefreshDailySchedule

特定の時間間隔で毎日データを更新するスケジュール。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  }
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュール設定されている時間間隔の開始時間。hours 部分のみが使用されます。時間間隔のサイズは、デフォルトでスプレッドシート エディタのサイズになります。

TimeOfDay

1 日のうちの時間を表します。日付とタイムゾーンは重要ではないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

JSON 表現 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
フィールド
hours

integer

24 時間形式の時間。0 以上の値を指定してください。通常は 23 以下にする必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。
minutes

integer

分。0 以上 59 以下にする必要があります。
seconds

integer

1 分の秒数。0 以上で、通常は 59 以下にする必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

秒の小数部分（ナノ秒単位）。0 以上 999,999,999 以下にする必要があります。

DataSourceRefreshWeeklySchedule

特定の期間内の特定の日にデータを更新する週単位のスケジュール。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュール設定されている時間間隔の開始時間。hours 部分のみが使用されます。時間間隔のサイズは、デフォルトでスプレッドシート エディタのサイズになります。
daysOfWeek[]

enum (DayOfWeek)

更新する曜日。少なくとも 1 日は指定してください。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日は指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY Wednesday
THURSDAY 木曜日
FRIDAY 金曜日
SATURDAY 土曜日
SUNDAY 日曜日

DataSourceRefreshMonthlySchedule

特定の期間に、月の特定の日にデータを更新する月次スケジュール。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュール設定されている時間間隔の開始時間。hours 部分のみが使用されます。時間間隔のサイズは、デフォルトでスプレッドシート エディタのサイズになります。
daysOfMonth[]

integer

更新する日付。1 ～ 28 のみがサポートされ、1 日から 28 日にマッピングされます。少なくとも 1 日は指定してください。

間隔

タイムスタンプの開始（包括）とタイムスタンプの終了（除外）としてエンコードされた時間間隔を表します。

開始時間は終了時間以下にする必要があります。開始時間が終了時間と等しい場合、期間は空になります（どの時間にも一致しません）。開始と終了の両方が指定されていない場合、間隔は任意の時刻と一致します。

JSON 表現 
{
  "startTime": string,
  "endTime": string
}
フィールド
startTime

string (Timestamp format)

省略可。期間の開始値（この値を含みます）。

指定する場合は、この期間に一致するタイムスタンプが開始時刻と同じかそれ以降である必要があります。
endTime

string (Timestamp format)

省略可。間隔の終了時間です（この時間は含まれません）。

指定する場合、この期間に一致するタイムスタンプは終了時間より前にする必要があります。

メソッド

batchUpdate

 スプレッドシートに 1 つ以上の更新を適用します。

create

 スプレッドシートを作成して、新しく作成されたスプレッドシートを返します。

get

 指定された ID のスプレッドシートを返します。

getByDataFilter

 指定された ID のスプレッドシートを返します。