Method: processes.list

اطلاعات مربوط به فرآیندهای انجام شده توسط یا از طرف یک کاربر، مانند نوع فرآیند و وضعیت فعلی را فهرست کنید.

درخواست HTTP

GET https://script.googleapis.com/v1/processes

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
userProcessFilter

object ( ListUserProcessesFilter )

فیلتری که برای محدود کردن نتایج لیست استفاده می شود. فقط فرآیندهای مطابق با معیارهای فیلتر بازگردانده می شوند.

pageSize

integer

حداکثر تعداد فرآیندهای برگشتی در هر صفحه از نتایج. پیش فرض 50 است.

pageToken

string

نشانه برای ادامه درخواست لیست قبلی در صفحه بعد. این باید روی مقدار nextPageToken از پاسخ قبلی تنظیم شود.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پاسخ با لیست منابع Process .

نمایندگی JSON 
{
  "processes": [
    {
      object (Process)
    }
  ],
  "nextPageToken": string
}
فیلدها
processes[]

object ( Process )

فهرستی از فرآیندهایی که با پارامترهای درخواست مطابقت دارند.

nextPageToken

string

نشانه برای صفحه بعدی نتایج. اگر خالی باشد، صفحه دیگری باقی نمانده است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/script.processes

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListUserProcessesFilter

از فیلتر برای تعیین بیشتر فرآیندهای فهرست استفاده می شود. فقط فرآیندهایی که با تمام شرایط مشخص شده مطابقت دارند بازگردانده می شوند.

نمایندگی JSON 
{
  "scriptId": string,
  "deploymentId": string,
  "projectName": string,
  "functionName": string,
  "startTime": string,
  "endTime": string,
  "types": [
    enum (ProcessType)
  ],
  "statuses": [
    enum (ProcessStatus)
  ],
  "userAccessLevels": [
    enum (UserAccessLevel)
  ]
}
فیلدها
scriptId

string

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به فرآیندهایی که از پروژه‌هایی با شناسه اسکریپت خاص نشات می‌گیرند استفاده می‌شود.

deploymentId

string

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به فرآیندهایی که از پروژه‌هایی با شناسه استقرار خاص نشات می‌گیرند استفاده می‌شود.

projectName

string

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به فرآیندهایی که از پروژه‌هایی با نام پروژه حاوی یک رشته خاص هستند، استفاده می‌شود.

functionName

string

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که از یک تابع اسکریپت با نام تابع داده شده منشأ می گیرند، استفاده می شود.

startTime

string ( Timestamp format)

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که در یا بعد از مهر زمانی مشخص شروع شده‌اند استفاده می‌شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که در یا قبل از مهر زمانی داده شده تکمیل شده اند استفاده می شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

types[]

enum ( ProcessType )

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که یکی از انواع فرآیند مشخص شده را دارند استفاده می شود.

statuses[]

enum ( ProcessStatus )

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به آنهایی که یکی از وضعیت‌های فرآیند مشخص شده را دارند، استفاده می‌شود.

userAccessLevels[]

enum ( UserAccessLevel )

فیلد اختیاری برای محدود کردن فرآیندهای برگشتی به مواردی که یکی از سطوح دسترسی کاربر مشخص شده را دارند، استفاده می‌شود.