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

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

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