Cells

CellData

特定のセルに関するデータ。

JSON 表現
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  },
  "chipRuns": [
    {
      object (ChipRun)
    }
  ]
}
フィールド
userEnteredValue

object (ExtendedValue)

ユーザーがセルに入力した値。例:1234'Hello'、または =NOW() 注: 日付、時刻、日時は serial number 形式の倍精度浮動小数点数として表されます。

effectiveValue

object (ExtendedValue)

セルの有効な値。数式を含むセルの場合は、計算値になります。リテラルを含むセルの場合、これは userEnteredValue と同じです。このフィールドは読み取り専用です。

formattedValue

string

セルの書式設定された値。これはユーザーに表示される値です。このフィールドは読み取り専用です。

userEnteredFormat

object (CellFormat)

ユーザーがセルに入力した形式。

書き込み時に、新しい形式が既存の形式と統合されます。

effectiveFormat

object (CellFormat)

セルで使用されている有効な形式。これには、条件付き書式を適用した結果と、セルに数式が含まれている場合は計算された数値形式が含まれます。有効な形式がデフォルトの形式の場合、有効な形式は書き込まれません。このフィールドは読み取り専用です。

note

string

セルに関するメモ。

textFormatRuns[]

object (TextFormatRun)

セルのサブセクションに適用されるリッチテキストの実行。実行は、ユーザーが入力した文字列でのみ有効です。数式、ブール値、数値では有効ではありません。実行のプロパティは、テキスト内の特定のインデックスから始まり、次の実行まで続きます。明示的に変更しない限り、実行はセルのプロパティを継承します。

書き込みを行うと、新しい実行によって以前の実行が上書きされます。新しい userEnteredValue を書き込むと、以前の実行は消去されます。

dataValidation

object (DataValidationRule)

セルに設定されているデータ入力規則(ある場合)。

書き込み時に、新しいデータ検証ルールは以前のルールを上書きします。

pivotTable

object (PivotTable)

このセルに固定されたピボット テーブル。ピボット テーブル自体のサイズは、データ、グループ化、フィルタ、値などに基づいて動的に計算されます。ピボット テーブルの左上のセルにのみ、ピボット テーブルの定義が含まれます。他のセルには、ピボットの結果の計算値が effectiveValue フィールドに含まれます。

dataSourceTable

object (DataSourceTable)

このセルに固定されたデータソース テーブル。データソース テーブル自体のサイズは、構成に基づいて動的に計算されます。データソース テーブルの最初のセルにのみ、データソース テーブルの定義が含まれます。他のセルには、データソース テーブルの結果の表示値が effectiveValue フィールドに含まれます。

dataSourceFormula

object (DataSourceFormula)

出力専用。セル上のデータソース数式に関する情報。userEnteredValueDATA_SOURCE シートを参照する数式(=SUM(DataSheet!Column) など)の場合、このフィールドが設定されます。

chipRuns[]

object (ChipRun)

省略可。セルのサブセクションに適用されるチップの実行。実行のプロパティは、テキスト内の特定のインデックスから始まり、次の実行まで続きます。

読み取り時には、チップ付きのランニングとチップなしのランニングの両方が含まれます。チップなしのランニングには、空の Chip が含まれます。

ランニングの記録には、チップを使用したランニングのみが含まれます。チップを含む実行の長さは 1 で、ユーザーが入力したテキストでは「@」プレースホルダ記号で表されます。新しい実行は、以前の実行を上書きします。新しい userEnteredValue を書き込むと、以前の実行が消去されます。

CellFormat

セルの形式。

JSON 表現
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
フィールド
numberFormat

object (NumberFormat)

数値の値をユーザーに表示する方法を説明する形式。

backgroundColor
(deprecated)

object (Color)

セルの背景色。非推奨: backgroundColorStyle を使用します。

backgroundColorStyle

object (ColorStyle)

セルの背景色。backgroundColor も設定されている場合、このフィールドが優先されます。

borders

object (Borders)

セルの枠線。

padding

object (Padding)

セルのパディング。

horizontalAlignment

enum (HorizontalAlign)

セル内の値の水平方向の配置。

verticalAlignment

enum (VerticalAlign)

セル内の値の垂直方向の配置。

wrapStrategy

enum (WrapStrategy)

セル内の値の折り返し戦略。

textDirection

enum (TextDirection)

セル内のテキストの方向。

textFormat

object (TextFormat)

セル内のテキストの形式(形式の実行によってオーバーライドされない場合)。ここでセルレベルのリンクを設定すると、セルの既存のリンクがクリアされます。TextFormatRun でリンク フィールドを設定すると、セルレベルのリンクよりも優先されます。

textRotation

object (TextRotation)

セル内のテキストに適用される回転。

NumberFormat

セルの数値形式。

JSON 表現
{
  "type": enum (NumberFormatType),
  "pattern": string
}
フィールド
type

enum (NumberFormatType)

数値の形式のタイプ。書き込み時に、このフィールドを設定する必要があります。

pattern

string

フォーマットに使用されるパターン文字列。設定されていない場合は、指定された型で必要に応じて、スプレッドシートの言語 / 地域に基づくデフォルトのパターンが使用されます。サポートされているパターンの詳細については、日付と数値の形式に関するガイドをご覧ください。

NumberFormatType

セルの数値形式。このドキュメントでは、ロケールは en_US であると想定していますが、実際の形式はスプレッドシートのロケールによって異なります。

列挙型
NUMBER_FORMAT_TYPE_UNSPECIFIED 数値の形式が指定されておらず、セルの内容に基づいています。明示的に使用しないでください。
TEXT テキストの書式設定(1000.12 など)
NUMBER 数値形式(例: 1,000.12
PERCENT パーセント形式(例: 10.12%
CURRENCY 通貨形式(例: $1,000.12
DATE 日付の形式(例: 9/26/2008
TIME 時間形式(例: 3:59:00 PM
DATE_TIME 日付と時刻の形式(例: 9/26/08 15:59:00
SCIENTIFIC 科学的表記形式(例: 1.01E+03

枠線

セルの枠線。

JSON 表現
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
フィールド
top

object (Border)

セルの上枠線。

bottom

object (Border)

セルの下枠線。

left

object (Border)

セルの左枠線。

right

object (Border)

セルの右枠線。

Border

セルに沿った枠線。

JSON 表現
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
フィールド
style

enum (Style)

枠線のスタイル。

width
(deprecated)

integer

枠線の幅(ピクセル単位)。非推奨。幅は「style」フィールドで決定されます。

color
(deprecated)

object (Color)

枠線の色。非推奨: colorStyle を使用します。

colorStyle

object (ColorStyle)

枠線の色。color も設定されている場合、このフィールドが優先されます。

スタイル

枠線のスタイル。

列挙型
STYLE_UNSPECIFIED スタイルが指定されていません。使用しないでください。
DOTTED 枠線が点線です。
DASHED ボーダーが破線です。
SOLID 枠線は細い実線です。
SOLID_MEDIUM 境界線はやや細い実線です。
SOLID_THICK 枠線は太い実線です。
NONE 枠線なし。枠線を消去するために更新する場合にのみ使用されます。
DOUBLE 枠線は 2 本の実線です。

パディング

セルの周囲のパディングの量(ピクセル単位)。パディングを更新する場合は、すべてのフィールドを指定する必要があります。

JSON 表現
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
フィールド
top

integer

セルの上部のパディング。

right

integer

セルの右側のパディング。

bottom

integer

セルの下部のパディング。

left

integer

セルの左側のパディング。

VerticalAlign

セル内のテキストの垂直方向の配置。

列挙型
VERTICAL_ALIGN_UNSPECIFIED 垂直方向の配置が指定されていません。使用しないでください。
TOP テキストは明示的にセルの上部に配置されます。
MIDDLE テキストはセルの中央に明示的に配置されます。
BOTTOM テキストがセルの下部に明示的に配置されています。

WrapStrategy

セル内のテキストを折り返す方法。

列挙型
WRAP_STRATEGY_UNSPECIFIED デフォルト値。使用しないでください。
OVERFLOW_CELL

セルの幅を超える行は、そのセルが空である限り、次のセルに書き込まれます。次のセルが空でない場合、この動作は CLIP と同じになります。ユーザーが手動で改行を挿入しない限り、テキストが次の行に折り返されることはありません。例:

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

この折り返し戦略は、行よりも長い単語が分割されずに切り捨てられる古い Google スプレッドシートの折り返し戦略を表します。この戦略はすべてのプラットフォームでサポートされているわけではなく、段階的に廃止されています。例:

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

セルの幅を超える行は切り取られます。ユーザーが手動で改行を挿入しない限り、テキストが次の行に折り返されることはありません。例:

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

1 行を超える単語は、切り捨てられるのではなく、文字レベルで折り返されます。例:

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

TextDirection

セル内のテキストの方向。

列挙型
TEXT_DIRECTION_UNSPECIFIED テキストの方向が指定されていません。使用しないでください。
LEFT_TO_RIGHT ユーザーが左から右へのテキスト方向を設定しました。
RIGHT_TO_LEFT ユーザーが右から左へのテキスト方向を設定しました。

HyperlinkDisplayType

ハイパーリンクを明示的にレンダリングするかどうか。指定しない場合、ハイパーリンクはリンクされます。

列挙型
LINKED ハイパーリンクは明示的にレンダリングする必要があります。
PLAIN_TEXT ハイパーリンクはレンダリングされません。

TextRotation

セル内のテキストに適用される回転。

JSON 表現
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
フィールド
共用体フィールド type。回転のタイプ(垂直または斜め)。type は次のいずれかになります。
angle

integer

標準の向きと目的の向きの間の角度。度単位で測定されます。有効な値は -90 ~ 90 です。正の角度は上向き、負の角度は下向きになります。

注: LTR テキストの向きの場合、正の角度は反時計回りですが、RTL の場合は時計回りです。

vertical

boolean

true の場合、テキストは上から下に読み取られますが、個々の文字の向きは変わりません。次に例を示します。

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

テキスト形式の実行。この実行の形式は、次の実行の開始インデックスまで続きます。更新するときは、すべてのフィールドを設定する必要があります。

JSON 表現
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
フィールド
startIndex

integer

このランが開始される 0 ベースの文字インデックス(UTF-16 コード単位)。

format

object (TextFormat)

この実行の形式。値がない場合は、セルの形式が継承されます。

DataValidationRule

データ検証ルール。

JSON 表現
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
フィールド
condition

object (BooleanCondition)

セル内のデータが満たす必要がある条件。

inputMessage

string

セルにデータを追加するときにユーザーに表示するメッセージ。

strict

boolean

無効なデータを拒否する場合は true。

showCustomUi

boolean

条件の種類に基づいて UI をカスタマイズする必要がある場合は true。true の場合、「リスト」条件にプルダウンが表示されます。

DataSourceTable

データソース テーブル。ユーザーは DataSource から Sheets にデータの静的テーブルをインポートできます。これは、スプレッドシート エディタの「抽出」とも呼ばれます。

JSON 表現
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
dataSourceId

string

データソース テーブルが関連付けられているデータソースの ID。

columnSelectionType

enum (DataSourceTableColumnSelectionType)

データソース テーブルの列を選択する型。デフォルトは SELECTED です。

columns[]

object (DataSourceColumnReference)

データソース テーブルで選択された列。columnSelectionTypeSELECTED にする必要があります。

filterSpecs[]

object (FilterSpec)

データソース テーブルの仕様をフィルタします。

sortSpecs[]

object (SortSpec)

データソース テーブルの並べ替え仕様。データソース テーブルの結果は、並べ替えの指定に基づいて順に並べ替えられます。

rowLimit

integer

返す行数の上限。設定されていない場合は、デフォルトの上限が適用されます。デフォルトの上限と最大上限については、スプレッドシート エディタをご覧ください。

dataExecutionStatus

object (DataExecutionStatus)

出力専用。データの実行ステータス。

DataSourceTableColumnSelectionType

データソース テーブルの列選択タイプ。

列挙型
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED デフォルトの列選択タイプ。使用しないでください。
SELECTED columns フィールドで指定された列を選択します。
SYNC_ALL

データソースの現在および今後のすべての列を同期します。

設定されている場合、データソース テーブルは更新時にデータソース内のすべての列を取得します。

DataSourceFormula

データソースの数式。

JSON 表現
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
dataSourceId

string

数式が関連付けられているデータソースの ID。

dataExecutionStatus

object (DataExecutionStatus)

出力専用。データの実行ステータス。

ChipRun

チップの実行。チップは、次の実行の開始インデックスまで続きます。

JSON 表現
{
  "startIndex": integer,
  "chip": {
    object (Chip)
  }
}
フィールド
startIndex

integer

必須。このランが開始される 0 ベースの文字インデックス(UTF-16 コード単位)。

chip

object (Chip)

省略可。この実行のチップ。

チップ

スマートチップ。

JSON 表現
{

  // Union field properties can be only one of the following:
  "personProperties": {
    object (PersonProperties)
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
  // End of list of possible types for union field properties.
}
フィールド
共用体フィールド properties。チップのプロパティ。properties は次のいずれかになります。
personProperties

object (PersonProperties)

リンクされた人物のプロパティ。

PersonProperties

リンクされた人物に固有のプロパティ。

JSON 表現
{
  "email": string,
  "displayFormat": enum (DisplayFormat)
}
フィールド
email

string

必須。このユーザーに関連付けられているメールアドレス。このフィールドは常に存在します。

displayFormat

enum (DisplayFormat)

省略可。ユーザーチップの表示形式。設定されていない場合は、デフォルトの表示形式が使用されます。

DisplayFormat

利用可能な場合の優先表示形式。

列挙型
DISPLAY_FORMAT_UNSPECIFIED デフォルト値。使用しないでください。
DEFAULT デフォルトの表示形式。
LAST_NAME_COMMA_FIRST_NAME 姓、名の表示形式。
EMAIL メールの表示形式。

RichLinkProperties

Google リソース(ドライブ内のファイル、YouTube 動画、マップの住所、カレンダーの予定など)へのリンクのプロパティ。チップとして書き込めるのはドライブ ファイルのみです。他のすべてのリッチリンク タイプは読み取り専用です。

書き込み時の URI は 2,000 バイトを超えてはなりません。

注: ドライブ ファイルチップを書き込むには、drive.filedrive.readonlydrive のいずれかの OAuth スコープが少なくとも 1 つ必要です。

JSON 表現
{
  "uri": string,
  "mimeType": string
}
フィールド
uri

string

必須。リンクの URI。これは常に存在します。

mimeType

string

出力専用。リンクの MIME タイプ(存在する場合。たとえば、Google ドライブ内のファイルの場合)。