Method: activities.list

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

درخواست HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userKey or all

string

شناسه پروفایل یا ایمیل کاربری که داده‌ها باید برای آن فیلتر شوند را نشان می‌دهد. می‌تواند برای همه اطلاعات all یا برای شناسه منحصر به فرد پروفایل Google Workspace کاربر یا آدرس ایمیل اصلی او userKey باشد. نباید کاربر حذف شده باشد. برای یک کاربر حذف شده، users.list در Directory API با showDeleted=true فراخوانی کنید، سپس از ID برگردانده شده به عنوان userKey استفاده کنید.

applicationName

enum ( ApplicationName )

نام برنامه‌ای که رویدادها برای آن بازیابی می‌شوند.

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

پارامترها
actorIpAddress

string

آدرس پروتکل اینترنت (IP) میزبان که رویداد در آن انجام شده است. این یک روش اضافی برای فیلتر کردن خلاصه گزارش با استفاده از آدرس IP کاربری است که فعالیت او گزارش می‌شود. این آدرس IP ممکن است منعکس کننده موقعیت فیزیکی کاربر باشد یا نباشد. به عنوان مثال، آدرس IP می‌تواند آدرس سرور پروکسی کاربر یا آدرس یک شبکه خصوصی مجازی (VPN) باشد. این پارامتر از هر دو نسخه آدرس IPv4 و IPv6 پشتیبانی می‌کند.

customerId

string

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

endTime

string

پایان بازه زمانی نشان داده شده در گزارش را تنظیم می‌کند. تاریخ در قالب RFC 3339 است، برای مثال 2010-10-28T10:26:35.000Z. مقدار پیش‌فرض، زمان تقریبی درخواست API است. یک گزارش API دارای سه مفهوم اساسی زمان است:

  • تاریخ درخواست گزارش توسط API : زمانی که API گزارش را ایجاد و بازیابی کرده است.
  • زمان شروع گزارش : ابتدای بازه زمانی نشان داده شده در گزارش. startTime باید قبل از endTime (در صورت مشخص شدن) و زمان فعلی هنگام ارسال درخواست باشد، در غیر این صورت API خطا برمی‌گرداند.
  • زمان پایان گزارش : پایان بازه زمانی نشان داده شده در گزارش. برای مثال، بازه زمانی رویدادهای خلاصه شده در یک گزارش می‌تواند از آوریل شروع و در مه پایان یابد. خود گزارش را می‌توان در آگوست درخواست کرد.
اگر endTime مشخص نشده باشد، گزارش تمام فعالیت‌ها را از startTime تا زمان فعلی یا آخرین ۱۸۰ روز (اگر startTime بیش از ۱۸۰ روز گذشته باشد) برمی‌گرداند.

برای درخواست‌های Gmail، startTime و endTime باید ارائه شود و اختلاف آنها نباید بیشتر از 30 روز باشد.

eventName

string

نام رویدادی که توسط API مورد پرسش قرار می‌گیرد. هر eventName مربوط به یک سرویس یا ویژگی خاص Google Workspace است که API آن را به انواع رویدادها سازماندهی می‌کند. به عنوان مثال، رویدادهای Google Calendar در گزارش‌های برنامه کنسول مدیریت است. ساختار type Calendar Settings شامل تمام فعالیت‌های Calendar eventName گزارش شده توسط API است. هنگامی که یک مدیر یک تنظیم Calendar را تغییر می‌دهد، API این فعالیت را در پارامترهای Calendar Settings type و eventName گزارش می‌دهد. برای اطلاعات بیشتر در مورد رشته‌های پرسش و پارامترهای eventName ، به لیست نام‌های رویداد برای برنامه‌های مختلف در بالا در applicationName مراجعه کنید.

filters

string

رشته پرس‌وجوی filters ، فهرستی جدا شده با کاما است که از پارامترهای رویداد که توسط عملگرهای رابطه‌ای دستکاری می‌شوند، تشکیل شده است. پارامترهای رویداد به شکل {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

این پارامترهای رویداد با یک eventName خاص مرتبط هستند. اگر پارامتر درخواست متعلق به eventName نباشد، یک گزارش خالی برگردانده می‌شود. برای اطلاعات بیشتر در مورد فیلدهای eventName موجود برای هر برنامه و پارامترهای مرتبط با آنها، به جدول ApplicationName بروید، سپس روی صفحه رویدادهای فعالیت در پیوست برنامه مورد نظر خود کلیک کنید.

در مثال‌های زیر از فعالیت Drive، لیست برگردانده شده شامل تمام رویدادهای edit است که در آن‌ها مقدار پارامتر doc_id با شرایط تعریف شده توسط عملگر رابطه‌ای مطابقت دارد. در مثال اول، درخواست تمام اسناد ویرایش شده با مقدار doc_id برابر با 12345 را برمی‌گرداند. در مثال دوم، گزارش هر سند ویرایش شده‌ای را که مقدار doc_id آن برابر با 98765 نیست، برمی‌گرداند. عملگر <> در رشته پرس و جوی درخواست ( %3C%3E ) به صورت URL-encoded شده است:

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

یک پرس‌وجوی filters از این عملگرهای رابطه‌ای پشتیبانی می‌کند:

  • == —'مساوی با'.
  • <> —'برابر نیست با'. باید با URL کدگذاری شده باشد (%3C%3E).
  • < —'کمتر از'. باید با URL کدگذاری شده باشد (%3C).
  • <= —'کوچکتر یا مساوی'. باید با URL کدگذاری شود (%3C=).
  • > —'بزرگتر از'. باید با URL کدگذاری شده باشد (%3E).
  • >= —'بزرگتر یا مساوی'. باید با URL کدگذاری شود (%3E=).

نکته: API مقادیر چندگانه برای یک پارامتر را نمی‌پذیرد. اگر یک پارامتر بیش از یک بار در درخواست API ارائه شود، API فقط آخرین مقدار آن پارامتر را می‌پذیرد. علاوه بر این، اگر یک پارامتر نامعتبر در درخواست API ارائه شود، API آن پارامتر را نادیده می‌گیرد و پاسخ مربوط به پارامترهای معتبر باقی مانده را برمی‌گرداند. اگر هیچ پارامتری درخواست نشود، همه پارامترها بازگردانده می‌شوند.

maxResults

integer

تعیین می‌کند که چند رکورد فعالیت در هر صفحه پاسخ نشان داده شود. برای مثال، اگر درخواست maxResults=1 تنظیم شود و گزارش دارای دو فعالیت باشد، گزارش دارای دو صفحه خواهد بود. ویژگی nextPageToken پاسخ، توکن صفحه دوم را دارد. رشته پرس و جوی maxResults در درخواست اختیاری است. مقدار پیش‌فرض ۱۰۰۰ است.

orgUnitID

string

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

pageToken

string

توکنی که صفحه بعدی را مشخص می‌کند. گزارشی با چندین صفحه، در پاسخ خود دارای ویژگی nextPageToken است. در درخواست بعدی خود برای دریافت صفحه بعدی گزارش، مقدار nextPageToken را در رشته پرس و جوی pageToken وارد کنید.

startTime

string

شروع محدوده زمانی نشان داده شده در گزارش را تنظیم می‌کند. تاریخ در قالب RFC 3339 است، برای مثال 2010-10-28T10:26:35.000Z. گزارش تمام فعالیت‌ها را از startTime تا endTime برمی‌گرداند. startTime باید قبل از endTime (در صورت مشخص شدن) و زمان فعلی هنگام ارسال درخواست باشد، در غیر این صورت API خطایی را برمی‌گرداند.

برای درخواست‌های Gmail، startTime و endTime باید ارائه شود و اختلاف آنها نباید بیشتر از 30 روز باشد.

groupIdFilter

string

شناسه‌های گروه جدا شده با کاما (مبهم‌سازی شده) که فعالیت‌های کاربران بر اساس آنها فیلتر می‌شود، یعنی پاسخ فقط شامل فعالیت‌های کاربرانی خواهد بود که جزئی از حداقل یکی از شناسه‌های گروه‌های ذکر شده در اینجا هستند. قالب: "id:abc123,id:xyz456"

درخواست بدنه

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

بدنه پاسخ

قالب JSON برای مجموعه‌ای از فعالیت‌ها.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
فیلدها
kind

string

نوع منبع API. برای گزارش فعالیت، مقدار reports#activities است.

etag

string

برچسب منبع (ETag).

items[]

object ( Activity )

هر رکورد فعالیت در پاسخ.

nextPageToken

string

توکنی برای بازیابی صفحه بعدی گزارش. مقدار nextPageToken در رشته پرس و جوی pageToken درخواست استفاده می‌شود.

دامنه‌های مجوز

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

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

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

نام برنامه

انوم‌ها
access_transparency

گزارش‌های فعالیت شفافیت دسترسی به فضای کاری گوگل (Google Workspace Access Transparency) اطلاعاتی درباره انواع مختلف رویدادهای فعالیت شفافیت دسترسی ارائه می‌دهند.

admin

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

calendar

گزارش‌های فعالیت برنامه تقویم گوگل، اطلاعاتی درباره رویدادهای مختلف فعالیت تقویم ارائه می‌دهند.

chat گزارش‌های فعالیت چت، اطلاعاتی در مورد رویدادهای مختلف فعالیت چت ارائه می‌دهند.
drive

گزارش‌های فعالیت برنامه Google Drive اطلاعاتی درباره رویدادهای مختلف فعالیت Google Drive ارائه می‌دهند. گزارش فعالیت Drive فقط برای مشتریان Google Workspace Business و Enterprise در دسترس است.

gcp گزارش‌های فعالیت برنامه‌ی پلتفرم ابری گوگل، اطلاعاتی در مورد رویدادهای مختلف فعالیت GCP ارائه می‌دهند.
gmail گزارش‌های فعالیت برنامه Gmail اطلاعاتی درباره رویدادهای مختلف فعالیت Gmail ارائه می‌دهند.
gplus گزارش‌های فعالیت برنامه Google+ اطلاعاتی درباره رویدادهای مختلف فعالیت Google+ ارائه می‌دهند.
groups

گزارش‌های فعالیت برنامه Google Groups اطلاعاتی درباره رویدادهای مختلف فعالیت گروه‌ها ارائه می‌دهند.

groups_enterprise

گزارش‌های فعالیت گروه‌های سازمانی، اطلاعاتی در مورد رویدادهای مختلف فعالیت گروه‌های سازمانی ارائه می‌دهند.

jamboard گزارش‌های فعالیت Jamboard اطلاعاتی در مورد رویدادهای مختلف فعالیت Jamboard ارائه می‌دهند.
login

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

meet گزارش فعالیت Meet Audit اطلاعاتی درباره انواع مختلف رویدادهای فعالیت Meet Audit ارائه می‌دهد.
mobile گزارش فعالیت حسابرسی دستگاه، اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت حسابرسی دستگاه ارائه می‌دهد.
rules

گزارش فعالیت قوانین، اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت قوانین را ارائه می‌دهد.

saml

گزارش فعالیت SAML اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت SAML ارائه می‌دهد.

token

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

user_accounts

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

context_aware_access

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

chrome

گزارش‌های فعالیت کروم اطلاعاتی در مورد رویدادهای مرورگر کروم و سیستم‌عامل کروم ارائه می‌دهند.

data_studio گزارش‌های فعالیت Data Studio اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت Data Studio ارائه می‌دهند.
keep گزارش‌های فعالیت برنامه Keep اطلاعاتی درباره رویدادهای مختلف فعالیت Google Keep ارائه می‌دهند. گزارش فعالیت Keep فقط برای مشتریان Google Workspace Business و Enterprise در دسترس است.
vault گزارش‌های فعالیت Vault اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت Vault ارائه می‌دهند.
gemini_in_workspace_apps

گزارش‌های فعالیت Gemini برای Workspace اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت Gemini که توسط کاربران در یک برنامه Workspace انجام می‌شود، ارائه می‌دهند.

classroom گزارش‌های فعالیت کلاس درس، اطلاعاتی در مورد انواع مختلف رویدادهای فعالیت کلاس درس ارائه می‌دهند.

فعالیت

قالب JSON برای منبع فعالیت.

نمایش JSON 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
فیلدها
kind

string

نوع منبع API. برای گزارش فعالیت، مقدار audit#activity است.

etag

string

برچسب ET مربوط به اثر.

ownerDomain

string

این دامنه‌ای است که تحت تأثیر رویداد گزارش قرار می‌گیرد. برای مثال، دامنه کنسول ادمین یا مالک سند برنامه Drive.

ipAddress

string

آدرس IP کاربری که عمل را انجام می‌دهد. این آدرس پروتکل اینترنت (IP) کاربر هنگام ورود به Google Workspace است که ممکن است موقعیت فیزیکی کاربر را نشان دهد یا ندهد. به عنوان مثال، آدرس IP می‌تواند آدرس سرور پروکسی کاربر یا آدرس یک شبکه خصوصی مجازی (VPN) باشد. این API از IPv4 و IPv6 پشتیبانی می‌کند.

events[]

object

رویدادهای فعالیت در گزارش.

events[].type

string

نوع رویداد. سرویس یا ویژگی Google Workspace که یک مدیر تغییر می‌دهد، در ویژگی type شناسایی می‌شود که یک رویداد را با استفاده از ویژگی eventName شناسایی می‌کند. برای فهرست کامل دسته‌های type API، به فهرست نام‌های رویداد برای برنامه‌های مختلف در بالا در applicationName مراجعه کنید.

events[].name

string

نام رویداد. این نام خاص فعالیتی است که توسط API گزارش می‌شود. و هر eventName مربوط به یک سرویس یا ویژگی خاص Google Workspace است که API آن را به انواع رویدادها سازماندهی می‌کند.
برای پارامترهای درخواست eventName به طور کلی:

  • اگر هیچ eventName داده نشود، گزارش تمام نمونه‌های ممکن از یک eventName را برمی‌گرداند.
  • وقتی یک eventName درخواست می‌کنید، پاسخ API تمام فعالیت‌هایی را که شامل آن eventName هستند، برمی‌گرداند.

برای اطلاعات بیشتر در مورد ویژگی‌های eventName ، به لیست نام‌های رویداد برای برنامه‌های مختلف در بالا در applicationName مراجعه کنید.

events[].parameters[]

object

جفت‌های مقدار پارامتر برای برنامه‌های مختلف. برای اطلاعات بیشتر در مورد پارامترهای eventName ، به لیست نام‌های رویداد برای برنامه‌های مختلف در بالا در applicationName مراجعه کنید.

events[].parameters[].messageValue

object

جفت‌های مقدار پارامتر تودرتو مرتبط با این پارامتر. نوع مقدار پیچیده برای یک پارامتر به صورت لیستی از مقادیر پارامتر برگردانده می‌شود. برای مثال، پارامتر آدرس ممکن است مقداری به صورت [{parameter: [{name: city, value: abc}]}] داشته باشد.

events[].parameters[].messageValue.parameter[]

object ( NestedParameter )

مقادیر پارامتر

events[].parameters[].name

string

نام پارامتر.

events[].parameters[].value

string

مقدار رشته‌ای پارامتر.

events[].parameters[].multiValue[]

string

مقادیر رشته‌ای پارامتر.

events[].parameters[].intValue

string ( int64 format)

مقدار صحیح پارامتر.

events[].parameters[].multiIntValue[]

string ( int64 format)

مقادیر صحیح پارامتر.

events[].parameters[].boolValue

boolean

مقدار بولی پارامتر.

events[].parameters[].multiMessageValue[]

object

activities.list از اشیاء messageValue .

events[].parameters[].multiMessageValue[].parameter[]

object ( NestedParameter )

مقادیر پارامتر

events[].resourceIds[]

string

شناسه‌های منابع مرتبط با رویداد.

id

object

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

id.time

string

زمان وقوع فعالیت. این زمان در عصر یونیکس بر حسب ثانیه است.

id.uniqueQualifier

string ( int64 format)

اگر چندین رویداد زمان یکسانی داشته باشند، یک توصیفگر منحصر به فرد است.

id.applicationName

string

نام برنامه‌ای که رویداد به آن تعلق دارد. برای مقادیر ممکن، لیست برنامه‌های بالا را در applicationName ببینید.

id.customerId

string

شناسه منحصر به فرد برای حساب Google Workspace.

actor

object

کاربری که عمل را انجام می‌دهد.

actor.profileId

string

شناسه منحصر به فرد نمایه Google Workspace مربوط به بازیگر. اگر بازیگر کاربر Google Workspace نباشد، ممکن است این مقدار وجود نداشته باشد، یا ممکن است شماره 105250506097979753968 باشد که به عنوان شناسه مکان‌نما عمل می‌کند.

actor.email

string

آدرس ایمیل اصلی بازیگر. اگر هیچ آدرس ایمیلی مرتبط با بازیگر وجود نداشته باشد، ممکن است وجود نداشته باشد.

actor.callerType

string

نوع بازیگر.

actor.key

string

فقط زمانی وجود دارد که callerType KEY باشد. می‌تواند consumer_key درخواست‌کننده برای درخواست‌های API OAuth 2LO یا شناسه‌ای برای حساب‌های ربات باشد.

actor.applicationInfo

object

جزئیات درخواستی که عامل انجام فعالیت بوده است.

actor.applicationInfo.oauthClientId

string

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

actor.applicationInfo.applicationName

string

نام برنامه‌ای که برای انجام عمل مورد استفاده قرار می‌گیرد.

actor.applicationInfo.impersonation

boolean

اینکه آیا برنامه در حال جعل هویت یک کاربر بوده است یا خیر.

networkInfo

object ( NetworkInfo )

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

resourceDetails[]

object ( ResourceDetails )

جزئیات منبعی که عمل روی آن انجام شده است.

اطلاعات شبکه

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

نمایش JSON 
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
فیلدها
ipAsn[]

integer

آدرس IP کاربری که این عمل را انجام می‌دهد.

regionCode

string

کد منطقه ISO 3166-1 alpha-2 مربوط به کاربری که عمل را انجام می‌دهد.

subdivisionCode

string

کد منطقه‌ای ISO 3166-2 (ایالت‌ها و استان‌ها) برای کشورهای کاربر که این عمل را انجام می‌دهد.

جزئیات منابع

جزئیات منبعی که عمل روی آن انجام شده است.

نمایش JSON 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
فیلدها
id

string

شناسه منبع.

title

string

عنوان منبع. برای مثال، در مورد یک سند درایو، این عنوان سند خواهد بود. در مورد یک ایمیل، این موضوع خواهد بود.

type

string

نوع منبع - سند، ایمیل، پیام چت

appliedLabels[]

object ( AppliedLabel )

activities.list برچسب‌های اعمال‌شده روی منبع

relation

string

رابطه منبع با رویدادها را تعریف می‌کند

برچسب کاربردی

جزئیات برچسب اعمال شده روی منبع.

نمایش JSON 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
فیلدها
id

string

شناسه برچسب - فقط شناسه برچسب، نه نام کامل منبع OnePlatform.

title

string

عنوان برچسب

fieldValues[]

object ( FieldValue )

activities.list از فیلدهایی که بخشی از label هستند و توسط کاربر تنظیم شده‌اند. اگر label فیلدی داشته باشد که توسط کاربر تنظیم نشده باشد، در این لیست وجود نخواهد داشت.

reason

object ( Reason )

دلیل اعمال برچسب روی منبع.

مقدار فیلد

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

نمایش JSON 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
فیلدها
id

string

شناسه فیلد

displayName

string

نمایش نام فیلد

type

string

نوع فیلد

reason

object ( Reason )

دلیل اعمال فیلد به برچسب.

value فیلد از نوع Union. مقادیر ذخیره شده در فیلد را ذخیره می‌کند. value می‌تواند فقط یکی از موارد زیر باشد:
unsetValue

boolean

اگر فیلد تنظیم نشده باشد، این مقدار درست خواهد بود.

longTextValue

string

تنظیم مقدار متن طولانی

textValue

string

تنظیم مقدار متن.

textListValue

object ( TextListValue )

تنظیم مقدار لیست متنی

selectionValue

object ( SelectionValue )

تنظیم مقدار انتخابی با انتخاب یک مقدار واحد از یک منوی کشویی.

selectionListValue

object ( SelectionListValue )

تنظیم مقدار یک لیست انتخابی با انتخاب چندین مقدار از یک منوی کشویی.

integerValue

string ( int64 format)

تنظیم یک مقدار صحیح.

userValue

object ( UserValue )

تنظیم مقدار کاربر با انتخاب یک کاربر واحد.

userListValue

object ( UserListValue )

تنظیم مقدار لیست کاربران با انتخاب چندین کاربر.

dateValue

object ( Date )

تنظیم مقدار تاریخ.

مقدار لیست متن

تنظیم مقدار لیست متنی

نمایش JSON 
{
  "values": [
    string
  ]
}
فیلدها
values[]

string

فعالیت‌ها.لیست مقادیر متنی.

مقدار انتخاب

تنظیم مقدار انتخابی با انتخاب یک مقدار واحد از یک منوی کشویی.

نمایش JSON 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
فیلدها
id

string

شناسه انتخاب.

displayName

string

نمایش نام انتخاب.

badged

boolean

اینکه آیا انتخاب دارای نشان است یا خیر.

مقدار لیست انتخاب

تنظیم مقدار یک لیست انتخابی با انتخاب چندین مقدار از یک منوی کشویی.

نمایش JSON 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
فیلدها
values[]

object ( SelectionValue )

فعالیت‌ها. فهرست انتخاب‌ها.

ارزش کاربر

تنظیم مقدار کاربر با انتخاب یک کاربر واحد.

نمایش JSON 
{
  "email": string
}
فیلدها
email

string

ایمیل کاربر.

مقدار لیست کاربر

تنظیم مقدار لیست کاربران با انتخاب چندین کاربر.

نمایش JSON 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
فیلدها
values[]

object ( UserValue )

فعالیت‌ها. فهرست کاربران.

تاریخ

نشان دهنده یک تاریخ تقویمی کامل یا جزئی، مانند تاریخ تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده‌اند یا اهمیت چندانی ندارند. تاریخ نسبت به تقویم میلادی است. این می‌تواند یکی از موارد زیر را نشان دهد:

  • یک تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و یک روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با یک روز صفر (برای مثال، تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایش JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
فیلدها
year

integer

سال تاریخ. باید از ۱ تا ۹۹۹۹ باشد، یا برای مشخص کردن تاریخ بدون سال، ۰ باشد.

month

integer

ماه سال. باید از ۱ تا ۱۲ باشد، یا برای مشخص کردن سال بدون ماه و روز، ۰ باشد.

day

integer

روز ماه. باید از ۱ تا ۳۱ باشد و برای سال و ماه معتبر باشد، یا ۰ برای مشخص کردن یک سال به تنهایی یا یک سال و ماه که روز در آن مهم نیست.

دلیل

دلیل اعمال برچسب/فیلد.

نمایش JSON 
{
  "reasonType": string
}
فیلدها
reasonType

string

نوع دلیل.