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

رقم تعريف جدول البيانات. هذا الحقل للقراءة فقط.

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

  • رمز لغة وفقًا لمعيار ISO 639-2، مثل fil، في حال عدم توفُّر الرمز 639-1

  • مجموعة من رمز اللغة ورمز البلد وفقًا لمعيار 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 الخارجية لدوالّ الصور والاستيراد. القراءة فقط عندما تكون القيمة صحيحة عندما يكون الخطأ خطأ، يمكنك ضبطه على صحيح. سيتم تجاوز هذه القيمة وعرض القيمة "صحيح" دائمًا في حال تفعيل المشرف لميزة الإضافة إلى القائمة المسموح بها.

RecalculationInterval

قائمة بخيارات الفاصل الزمني المحتملة لإعادة الحساب

عمليات التعداد
RECALCULATION_INTERVAL_UNSPECIFIED القيمة التلقائية يجب عدم استخدام هذه القيمة.
ON_CHANGE يتم تعديل الدوال المتغيّرة عند كل تغيير.
MINUTE ويتم تعديل الدوال المتغيّرة عند كل تغيير وكل دقيقة.
HOUR يتم تعديل الدوال المتغيّرة عند كل تغيير وكل ساعة.

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

رقم تعريف النطاق المُعنوَن.

name

string

اسم النطاق المُعنوَن

range

object (GridRange)

النطاق الذي يمثله هذا.

DataSource

معلومات حول مصدر بيانات خارجي في جدول البيانات.

تمثيل JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
الحقول
dataSourceId

string

المعرّف الفريد على مستوى جدول البيانات الذي يحدّد مصدر البيانات مثال: 1080547365

spec

object (DataSourceSpec)

DataSourceSpec لمصدر البيانات المرتبط بجدول البيانات هذا

calculatedColumns[]

object (DataSourceColumn)

كل الأعمدة المحسوبة في مصدر البيانات.

sheetId

integer

معرّف Sheet المرتبط بمصدر البيانات لا يمكن تغيير الحقل بعد ضبطه.

عند إنشاء مصدر بيانات، يتم أيضًا إنشاء ورقة بيانات DATA_SOURCE مرتبطة بها. وإذا لم يتم تحديد الحقل، سيتم إنشاء رقم تعريف ورقة البيانات التي تم إنشاؤها عشوائيًا.

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

رقم تعريف مشروع على Google Cloud تم تفعيله BigQuery مع إرفاق حساب فوترة وبالنسبة إلى أي طلبات بحث تم تنفيذها على مصدر البيانات، يتم تحصيل رسوم المشروع.

حقل الربط 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 الذي ينتمي إليه الجدول. إذا لم يتم تحديد قيمة، يتم استخدام projectId.

tableId

string

معرّف جدول BigQuery

datasetId

string

رقم تعريف مجموعة بيانات BigQuery.

LookerDataSourceSpec

مواصفات مصدر بيانات Looker.

تمثيل JSON
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
الحقول
instanceUri

string

عنوان URL لنسخة Looker

model

string

اسم نموذج Looker

explore

string

اسم استكشاف نموذج Looker

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 معرِّف المَعلمة يمكن أن يكون identifier واحدًا فقط مما يلي:
name

string

المَعلمة المُسماة. يجب أن يكون معرّفًا شرعيًا للموقع الإلكتروني DataSource الذي يتيح ذلك. على سبيل المثال، معرّف BigQuery.

حقل الربط value قيمة المَعلمة يمكن أن يكون value واحدًا فقط مما يلي:
namedRangeId

string

رقم تعريف NamedRange. يجب أن يكون حجمها 1×1.

range

object (GridRange)

نطاق يحتوي على قيمة المَعلمة ويجب أن يكون حجمها 1×1.

DataSourceRefreshSchedule

جدولة إعادة تحميل مصدر البيانات

تتم إعادة تحميل مصادر البيانات في جدول البيانات خلال فاصل زمني. يمكنك تحديد وقت البدء بالنقر على زر "إعادة التحميل المجدولة" في محرر "جداول بيانات Google"، ولكن يتم تحديد الفاصل الزمني ليكون 4 ساعات. على سبيل المثال، إذا حدّدت وقت بدء الساعة 8 صباحًا، ستتم إعادة التحميل بين الساعة 8 صباحًا و12 ظهرًا كل يوم.

تمثيل 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

صحيح إذا كان جدول التحديث مفعّلاً، أو خطأ في الحالات الأخرى.

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 جزء فقط. يكون حجم الفترة الزمنية تلقائيًا كما هو محدّد في محرِّر "جداول بيانات Google".

TimeOfDay

تمثل وقتًا من اليوم. التاريخ والمنطقة الزمنية غير مهمّين أو تم تحديدهما في مكان آخر. قد تختار واجهة برمجة التطبيقات السماح بالثواني. الأنواع ذات الصلة هي google.type.Date وgoogle.protobuf.Timestamp.

تمثيل JSON
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
الحقول
hours

integer

ساعات اليوم بتنسيق 24 ساعة. يجب أن تتراوح القيمة بين 0 و23. قد تختار واجهة برمجة التطبيقات السماح بالقيمة "24:00:00" لسيناريوهات مثل وقت إغلاق العمل.

minutes

integer

دقائق الساعة من اليوم يجب أن تتراوح القيمة بين 0 و59.

seconds

integer

الثواني من الدقائق في الوقت يجب أن تتراوح القيمة عادةً بين 0 و59. قد تسمح واجهة برمجة التطبيقات بالقيمة 60 إذا كانت تسمح بالثواني الكبيسة.

nanos

integer

أجزاء من الثانية بالنانوثواني يجب أن تتراوح بين 0 و999,999,999.

DataSourceRefreshWeeklySchedule

جدول زمني أسبوعي لإعادة تحميل البيانات في أيام محدّدة خلال فاصل زمني معيّن

تمثيل JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
الحقول
startTime

object (TimeOfDay)

وقت البدء للفاصل الزمني الذي تمت جدولة إعادة تحميل مصدر البيانات خلاله. يتم استخدام hours جزء فقط. يتم ضبط حجم الفاصل الزمني تلقائيًا على ذلك في محرّر "جداول بيانات Google".

daysOfWeek[]

enum (DayOfWeek)

أيام الأسبوع التي تتم فيها إعادة تحميل البيانات يجب تحديد يوم واحد على الأقل.

DayOfWeek

يمثل يومًا من الأسبوع.

عمليات التعداد
DAY_OF_WEEK_UNSPECIFIED لم يتم تحديد اليوم من الأسبوع.
MONDAY الاثنين
TUESDAY الثلاثاء
WEDNESDAY الأربعاء
THURSDAY الخميس
FRIDAY الجمعة
SATURDAY السبت
SUNDAY الأحد

DataSourceRefreshMonthlySchedule

جدول زمني شهري لإعادة تحميل البيانات في أيام معيّنة من الشهر في فترة زمنية معيّنة

تمثيل JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
الحقول
startTime

object (TimeOfDay)

وقت بدء الفترة الزمنية التي يتم فيها جدولة إعادة تحميل مصدر البيانات. يتم استخدام hours جزء فقط. يتم ضبط حجم الفاصل الزمني تلقائيًا على ذلك في محرّر "جداول بيانات Google".

daysOfMonth[]

integer

أيام الشهر التي تريد إعادة تحميل البيانات فيها يمكن استخدام القيم من 1 إلى 28 فقط، ما يعادل اليوم الأول إلى اليوم 28. يجب تحديد يوم واحد على الأقل.

الفاصل

ويمثل فاصلاً زمنيًا مشفّرًا كبداية طابع زمني (شامل) ونهاية طابع زمني (غير شاملة).

يجب أن تكون البداية أقل من أو تساوي النهاية. عندما تساوي البداية النهاية، يكون الفاصل الزمني فارغًا (لا يتطابق أي وقت). وفي حال عدم تحديد قيمة كل من البداية والنهاية، يتطابق الفاصل الزمني في أي وقت.

تمثيل JSON
{
  "startTime": string,
  "endTime": string
}
الحقول
startTime

string (Timestamp format)

اختياريّ. بداية شاملة للفاصل الزمني.

يجب أن يكون الطابع الزمني الذي يطابق هذا الفاصل الزمني هو نفسه أو بعد بدئه في حال تحديده.

endTime

string (Timestamp format)

اختياريّ. نهاية الفاصل الزمني الحصرية

ويجب أن يقع الطابع الزمني الذي يتطابق مع هذا الفاصل الزمني قبل النهاية، في حال تحديده.

الطُرق

batchUpdate

يطبق تحديثًا واحدًا أو أكثر على جدول البيانات.

create

لإنشاء جدول بيانات، مع عرض جدول البيانات الذي تم إنشاؤه حديثًا.

get

لعرض جدول البيانات بالمعرف المحدد.

getByDataFilter

لعرض جدول البيانات الذي يحمل المعرّف المحدّد.