REST Resource: subscriptions

منبع: اشتراک

اشتراکی برای دریافت رویدادهای مربوط به یک منبع Google Workspace. برای کسب اطلاعات بیشتر در مورد اشتراک‌ها، به نمای کلی API رویدادهای Google Workspace مراجعه کنید.

نمایش JSON 
{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  "driveOptions": {
    object (DriveOptions)
  }
  "userAuthority": string,
  "serviceAccountAuthority": string
  "expireTime": string,
  "ttl": string
}
فیلدها
name

string

شناسه. نام منبع اشتراک.

قالب: subscriptions/{subscription}

uid

string

فقط خروجی. شناسه منحصر به فرد اختصاص داده شده توسط سیستم برای اشتراک.

targetResource

string

الزامی. تغییرناپذیر. منبع Google Workspace که برای رویدادها پایش می‌شود و به صورت نام کامل منبع قالب‌بندی شده است. برای کسب اطلاعات در مورد منابع هدف و رویدادهایی که از آنها پشتیبانی می‌کنند، به رویدادهای پشتیبانی‌شده Google Workspace مراجعه کنید.

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

eventTypes[]

string

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

انواع رویدادهای پشتیبانی‌شده به منبع هدف اشتراک شما بستگی دارد. برای جزئیات بیشتر، به رویدادهای پشتیبانی‌شده Google Workspace مراجعه کنید.

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

اگر نوع رویدادی را مشخص کنید که برای منبع هدف وجود ندارد، درخواست، کد وضعیت HTTP 400 Bad Request را برمی‌گرداند.

payloadOptions

object ( PayloadOptions )

اختیاری. گزینه‌هایی در مورد اینکه چه داده‌هایی باید در بار رویداد گنجانده شوند. فقط برای رویدادهای Google Chat و Google Drive پشتیبانی می‌شود.

notificationEndpoint

object ( NotificationEndpoint )

الزامی. تغییرناپذیر. نقطه پایانی که اشتراک، رویدادهایی مانند یک موضوع Pub/Sub را ارائه می‌دهد.

state

enum ( State )

فقط خروجی. وضعیت اشتراک. تعیین می‌کند که آیا اشتراک می‌تواند رویدادها را دریافت کرده و آنها را به نقطه پایانی اعلان تحویل دهد یا خیر.

suspensionReason

enum ( ErrorType )

فقط خروجی. خطایی که اشتراک را به حالت تعلیق درآورد.

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

authority

string

فقط خروجی. کاربری که ایجاد اشتراک را مجاز کرده است.

وقتی کاربر اشتراک را تأیید می‌کند، این فیلد و فیلد userAuthority مقدار یکسانی دارند و قالب آن به صورت زیر است:

قالب: users/{user}

برای کاربران Google Workspace، مقدار {user} فیلد user.id از Directory API است.

وقتی یک برنامه چت اشتراک را تأیید می‌کند، فقط فیلد serviceAccountAuthority پر می‌شود و این فیلد خالی است.

createTime

string ( Timestamp format)

فقط خروجی. زمان ایجاد اشتراک.

updateTime

string ( Timestamp format)

فقط خروجی. آخرین باری که اشتراک به‌روزرسانی شده است.

reconciling

boolean

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

etag

string

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

فیلد Union subscription_options . گزینه‌های اشتراک اضافی موجود برای منابع هدف خاص برای اشتراک‌های Google Workspace. subscription_options فقط می‌تواند یکی از موارد زیر باشد:
driveOptions

object ( DriveOptions )

اختیاری. ویژگی‌هایی که فقط برای اشتراک‌های موجود در منابع Drive پشتیبانی می‌شوند.

فیلد union authority_info . هویتی که ایجاد اشتراک را مجاز کرده است. authority_info فقط می‌تواند یکی از موارد زیر باشد:
userAuthority

string

فقط خروجی. کاربری که ایجاد اشتراک را مجاز کرده است. کاربر باید بتواند targetResource مشاهده کند.

برای کاربران Google Workspace، مقدار {user} فیلد user.id از Directory API است.

قالب: users/{user}

serviceAccountAuthority

string

فقط خروجی. حساب سرویسی که برای تأیید ایجاد اشتراک استفاده شده است. این حساب سرویس باید متعلق به همان پروژه Google Cloud باشد که در آن این اشتراک را ایجاد می‌کنید.

قالب: projects/{projectId}/serviceAccounts/{service_account_id}

expiration فیلد Union. زمان انقضای اشتراک.

حداکثر زمان انقضا بستگی به این دارد که آیا اشتراک شما شامل داده‌های منبع در payloadهای رویداد (که در فیلد PayloadOptions مشخص شده‌اند) می‌شود یا خیر:

  • اگر بارهای داده، داده‌های منابع را حذف کنند، تا ۷ روز.
  • اگر بارهای داده شامل داده‌های منبع باشند، حداکثر ۴ ساعت. اگر سازمان Google Workspace شما از طریق واگذاری دامنه به منبع دسترسی می‌دهد، می‌توانید زمان انقضای اشتراک را تا ۲۴ ساعت افزایش دهید.

پس از انقضای اشتراک، به طور خودکار حذف می‌شود. شما رویدادهای چرخه حیات را ۱۲ ساعت و یک ساعت قبل از انقضای اشتراک در notification_endpoint دریافت می‌کنید. برای جزئیات بیشتر، به بخش دریافت و پاسخ به رویدادهای چرخه حیات مراجعه کنید.

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

expireTime

string ( Timestamp format)

پیش‌فرض غیر خالی. مهر زمانی بر حسب UTC هنگام انقضای اشتراک. صرف نظر از آنچه در ورودی استفاده شده است، همیشه در خروجی نمایش داده می‌شود.

ttl

string ( Duration format)

فقط ورودی. زمان حیات (TTL) یا مدت زمان اشتراک. اگر مشخص نشده باشد یا روی 0 تنظیم شده باشد، از حداکثر مدت زمان ممکن استفاده می‌کند.

گزینه‌های درایو

گزینه‌های پشتیبانی‌شده‌ی اضافی برای ارائه رویدادهای Drive.

نمایش JSON 
{
  "includeDescendants": boolean
}
فیلدها
includeDescendants

boolean

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

  • اگر false ، اشتراک فقط رویدادهای مربوط به تغییرات در پوشه یا درایو اشتراکی که به عنوان targetResource مشخص شده است را دریافت می‌کند.
  • اگر true ، فیلد mimeType از منبع file باید روی application/vnd.google-apps.folder تنظیم شود.

برای جزئیات بیشتر، به انواع رویدادهای Google Drive مراجعه کنید.

گزینه‌های بار مفید

گزینه‌هایی در مورد اینکه چه داده‌هایی باید در بار رویداد گنجانده شوند. فقط برای رویدادهای Google Chat و Google Drive پشتیبانی می‌شود.

نمایش JSON 
{
  "includeResource": boolean,
  "fieldMask": string
}
فیلدها
includeResource

boolean

اختیاری. اینکه آیا محتوای رویداد شامل داده‌هایی درباره منبعی که تغییر کرده است، می‌شود یا خیر. برای مثال، برای رویدادی که در آن یک پیام Google Chat ایجاد شده است، آیا محتوای رویداد شامل داده‌هایی درباره منبع Message است یا خیر. اگر مقدار false باشد، محتوای رویداد فقط شامل نام منبع تغییر یافته می‌شود.

fieldMask

string ( FieldMask format)

اختیاری. اگر includeResource روی true تنظیم شده باشد، لیست فیلدهایی که باید در رویداد payload گنجانده شوند. فیلدها را با کاما از هم جدا کنید. به عنوان مثال، برای گنجاندن فرستنده پیام Google Chat و ایجاد زمان، message.sender,message.createTime را وارد کنید. در صورت حذف، payload شامل تمام فیلدهای منبع می‌شود.

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

نقطه پایانی اعلان

نقطه پایانی که اشتراک، رویدادها را ارائه می‌دهد.

نمایش JSON 
{

  "pubsubTopic": string
}
فیلدها

endpoint فیلد اتحادیه.

endpoint فقط می‌تواند یکی از موارد زیر باشد:

pubsubTopic

string

تغییرناپذیر. موضوع انتشار/زیرموضوعی که رویدادهای مربوط به اشتراک را دریافت می‌کند.

قالب: projects/{project}/topics/{topic}

شما باید موضوع را در همان پروژه Google Cloud که این اشتراک را ایجاد می‌کنید، ایجاد کنید.

توجه: API رویدادهای Google Workspace از کلیدهای ترتیبی برای رویدادهای ترتیبی استفاده می‌کند. اگر موضوع Cloud Pub/Sub دارای سیاست ذخیره‌سازی پیام باشد که به گونه‌ای پیکربندی شده باشد که نزدیکترین منطقه Google Cloud را حذف کند، انتشار رویدادها با کلیدهای ترتیبی با شکست مواجه خواهد شد.

وقتی تاپیک رویدادها را دریافت می‌کند، رویدادها به صورت پیام‌های Pub/Sub کدگذاری می‌شوند. برای جزئیات بیشتر، به اتصال پروتکل Pub/Sub گوگل کلود برای CloudEvents مراجعه کنید.

ایالت

حالت‌های ممکن برای اشتراک.

انوم‌ها
STATE_UNSPECIFIED مقدار پیش‌فرض. این مقدار استفاده نشده است.
ACTIVE اشتراک فعال است و می‌تواند رویدادها را دریافت و به نقطه پایانی اعلان خود ارسال کند.
SUSPENDED به دلیل وجود خطا، اشتراک قادر به دریافت رویدادها نیست. برای شناسایی خطا، به فیلد suspensionReason مراجعه کنید.
DELETED اشتراک حذف می‌شود.

نوع خطا

خطاهای احتمالی برای اشتراک.

انوم‌ها
ERROR_TYPE_UNSPECIFIED مقدار پیش‌فرض. این مقدار استفاده نشده است.
USER_SCOPE_REVOKED کاربر مجاز، اعطای یک یا چند محدوده OAuth را لغو کرده است. برای کسب اطلاعات بیشتر در مورد مجوز برای Google Workspace، به پیکربندی صفحه رضایت OAuth مراجعه کنید.
APP_SCOPE_REVOKED مدیر دامنه، اعطای یک یا چند محدوده OAuth را برای برنامه لغو کرده است.
RESOURCE_DELETED منبع مورد نظر برای اشتراک دیگر وجود ندارد.
USER_AUTHORIZATION_FAILURE کاربری که ایجاد اشتراک را مجاز کرده است، دیگر به منبع هدف اشتراک دسترسی ندارد.
APP_AUTHORIZATION_FAILURE برنامه‌ای که ایجاد اشتراک را مجاز کرده بود، دیگر به منبع هدف اشتراک دسترسی ندارد.
ENDPOINT_PERMISSION_DENIED برنامه Google Workspace دسترسی لازم برای ارسال رویدادها به نقطه پایانی اعلان اشتراک شما را ندارد.
ENDPOINT_NOT_FOUND نقطه پایانی اعلان اشتراک وجود ندارد، یا نقطه پایانی در پروژه Google Cloud که اشتراک را در آن ایجاد کرده‌اید، یافت نمی‌شود.
ENDPOINT_RESOURCE_EXHAUSTED به دلیل سهمیه ناکافی یا رسیدن به محدودیت سرعت، نقطه پایانی اعلان اشتراک نتوانست رویدادها را دریافت کند.
OTHER خطایی نامشخص رخ داده است.

روش‌ها

create

 یک اشتراک Google Workspace ایجاد می‌کند.

delete

 اشتراک Google Workspace را حذف می‌کند.

get

 جزئیات مربوط به اشتراک Google Workspace را دریافت می‌کند.

list

 اشتراک‌های Google Workspace را فهرست می‌کند.

patch

 اشتراک Google Workspace را به‌روزرسانی یا تمدید می‌کند.

reactivate

 اشتراک Google Workspace که به حالت تعلیق درآمده بود را دوباره فعال می‌کند.
،

منبع: اشتراک

اشتراکی برای دریافت رویدادهای مربوط به یک منبع Google Workspace. برای کسب اطلاعات بیشتر در مورد اشتراک‌ها، به نمای کلی API رویدادهای Google Workspace مراجعه کنید.

نمایش JSON 
{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  "driveOptions": {
    object (DriveOptions)
  }
  "userAuthority": string,
  "serviceAccountAuthority": string
  "expireTime": string,
  "ttl": string
}
فیلدها
name

string

شناسه. نام منبع اشتراک.

قالب: subscriptions/{subscription}

uid

string

فقط خروجی. شناسه منحصر به فرد اختصاص داده شده توسط سیستم برای اشتراک.

targetResource

string

الزامی. تغییرناپذیر. منبع Google Workspace که برای رویدادها پایش می‌شود و به صورت نام کامل منبع قالب‌بندی شده است. برای کسب اطلاعات در مورد منابع هدف و رویدادهایی که از آنها پشتیبانی می‌کنند، به رویدادهای پشتیبانی‌شده Google Workspace مراجعه کنید.

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

eventTypes[]

string

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

انواع رویدادهای پشتیبانی‌شده به منبع هدف اشتراک شما بستگی دارد. برای جزئیات بیشتر، به رویدادهای پشتیبانی‌شده Google Workspace مراجعه کنید.

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

اگر نوع رویدادی را مشخص کنید که برای منبع هدف وجود ندارد، درخواست، کد وضعیت HTTP 400 Bad Request را برمی‌گرداند.

payloadOptions

object ( PayloadOptions )

اختیاری. گزینه‌هایی در مورد اینکه چه داده‌هایی باید در بار رویداد گنجانده شوند. فقط برای رویدادهای Google Chat و Google Drive پشتیبانی می‌شود.

notificationEndpoint

object ( NotificationEndpoint )

الزامی. تغییرناپذیر. نقطه پایانی که اشتراک، رویدادهایی مانند یک موضوع Pub/Sub را ارائه می‌دهد.

state

enum ( State )

فقط خروجی. وضعیت اشتراک. تعیین می‌کند که آیا اشتراک می‌تواند رویدادها را دریافت کرده و آنها را به نقطه پایانی اعلان تحویل دهد یا خیر.

suspensionReason

enum ( ErrorType )

فقط خروجی. خطایی که اشتراک را به حالت تعلیق درآورد.

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

authority

string

فقط خروجی. کاربری که ایجاد اشتراک را مجاز کرده است.

وقتی کاربر اشتراک را تأیید می‌کند، این فیلد و فیلد userAuthority مقدار یکسانی دارند و قالب آن به صورت زیر است:

قالب: users/{user}

برای کاربران Google Workspace، مقدار {user} فیلد user.id از Directory API است.

وقتی یک برنامه چت اشتراک را تأیید می‌کند، فقط فیلد serviceAccountAuthority پر می‌شود و این فیلد خالی است.

createTime

string ( Timestamp format)

فقط خروجی. زمان ایجاد اشتراک.

updateTime

string ( Timestamp format)

فقط خروجی. آخرین باری که اشتراک به‌روزرسانی شده است.

reconciling

boolean

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

etag

string

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

فیلد Union subscription_options . گزینه‌های اشتراک اضافی موجود برای منابع هدف خاص برای اشتراک‌های Google Workspace. subscription_options فقط می‌تواند یکی از موارد زیر باشد:
driveOptions

object ( DriveOptions )

اختیاری. ویژگی‌هایی که فقط برای اشتراک‌های موجود در منابع Drive پشتیبانی می‌شوند.

فیلد union authority_info . هویتی که ایجاد اشتراک را مجاز کرده است. authority_info فقط می‌تواند یکی از موارد زیر باشد:
userAuthority

string

فقط خروجی. کاربری که ایجاد اشتراک را مجاز کرده است. کاربر باید بتواند targetResource مشاهده کند.

برای کاربران Google Workspace، مقدار {user} فیلد user.id از Directory API است.

قالب: users/{user}

serviceAccountAuthority

string

فقط خروجی. حساب سرویسی که برای تأیید ایجاد اشتراک استفاده شده است. این حساب سرویس باید متعلق به همان پروژه Google Cloud باشد که در آن این اشتراک را ایجاد می‌کنید.

قالب: projects/{projectId}/serviceAccounts/{service_account_id}

expiration فیلد Union. زمان انقضای اشتراک.

حداکثر زمان انقضا بستگی به این دارد که آیا اشتراک شما شامل داده‌های منبع در payloadهای رویداد (که در فیلد PayloadOptions مشخص شده‌اند) می‌شود یا خیر:

  • اگر بارهای داده، داده‌های منابع را حذف کنند، تا ۷ روز.
  • اگر بارهای داده شامل داده‌های منبع باشند، حداکثر ۴ ساعت. اگر سازمان Google Workspace شما از طریق واگذاری دامنه به منبع دسترسی می‌دهد، می‌توانید زمان انقضای اشتراک را تا ۲۴ ساعت افزایش دهید.

پس از انقضای اشتراک، به طور خودکار حذف می‌شود. شما رویدادهای چرخه حیات را ۱۲ ساعت و یک ساعت قبل از انقضای اشتراک در notification_endpoint دریافت می‌کنید. برای جزئیات بیشتر، به بخش دریافت و پاسخ به رویدادهای چرخه حیات مراجعه کنید.

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

expireTime

string ( Timestamp format)

پیش‌فرض غیر خالی. مهر زمانی بر حسب UTC هنگام انقضای اشتراک. صرف نظر از آنچه در ورودی استفاده شده است، همیشه در خروجی نمایش داده می‌شود.

ttl

string ( Duration format)

فقط ورودی. زمان حیات (TTL) یا مدت زمان اشتراک. اگر مشخص نشده باشد یا روی 0 تنظیم شده باشد، از حداکثر مدت زمان ممکن استفاده می‌کند.

گزینه‌های درایو

گزینه‌های پشتیبانی‌شده‌ی اضافی برای ارائه رویدادهای Drive.

نمایش JSON 
{
  "includeDescendants": boolean
}
فیلدها
includeDescendants

boolean

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

  • اگر false ، اشتراک فقط رویدادهای مربوط به تغییرات در پوشه یا درایو اشتراکی که به عنوان targetResource مشخص شده است را دریافت می‌کند.
  • اگر true ، فیلد mimeType از منبع file باید روی application/vnd.google-apps.folder تنظیم شود.

برای جزئیات بیشتر، به انواع رویدادهای Google Drive مراجعه کنید.

گزینه‌های بار مفید

گزینه‌هایی در مورد اینکه چه داده‌هایی باید در بار رویداد گنجانده شوند. فقط برای رویدادهای Google Chat و Google Drive پشتیبانی می‌شود.

نمایش JSON 
{
  "includeResource": boolean,
  "fieldMask": string
}
فیلدها
includeResource

boolean

اختیاری. اینکه آیا محتوای رویداد شامل داده‌هایی درباره منبعی که تغییر کرده است، می‌شود یا خیر. برای مثال، برای رویدادی که در آن یک پیام Google Chat ایجاد شده است، آیا محتوای رویداد شامل داده‌هایی درباره منبع Message است یا خیر. اگر مقدار false باشد، محتوای رویداد فقط شامل نام منبع تغییر یافته می‌شود.

fieldMask

string ( FieldMask format)

اختیاری. اگر includeResource روی true تنظیم شده باشد، لیست فیلدهایی که باید در رویداد payload گنجانده شوند. فیلدها را با کاما از هم جدا کنید. به عنوان مثال، برای گنجاندن فرستنده پیام Google Chat و ایجاد زمان، message.sender,message.createTime را وارد کنید. در صورت حذف، payload شامل تمام فیلدهای منبع می‌شود.

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

نقطه پایانی اعلان

نقطه پایانی که اشتراک، رویدادها را ارائه می‌دهد.

نمایش JSON 
{

  "pubsubTopic": string
}
فیلدها

endpoint فیلد اتحادیه.

endpoint فقط می‌تواند یکی از موارد زیر باشد:

pubsubTopic

string

تغییرناپذیر. موضوع Pub/Sub که رویدادهای مربوط به اشتراک را دریافت می‌کند.

قالب: projects/{project}/topics/{topic}

شما باید موضوع را در همان پروژه Google Cloud که این اشتراک را ایجاد می‌کنید، ایجاد کنید.

توجه: API رویدادهای Google Workspace از کلیدهای ترتیبی برای رویدادهای ترتیبی استفاده می‌کند. اگر موضوع Cloud Pub/Sub دارای سیاست ذخیره‌سازی پیام باشد که به گونه‌ای پیکربندی شده باشد که نزدیکترین منطقه Google Cloud را حذف کند، انتشار رویدادها با کلیدهای ترتیبی با شکست مواجه خواهد شد.

وقتی تاپیک رویدادها را دریافت می‌کند، رویدادها به صورت پیام‌های Pub/Sub کدگذاری می‌شوند. برای جزئیات بیشتر، به اتصال پروتکل Pub/Sub گوگل کلود برای CloudEvents مراجعه کنید.

ایالت

حالت‌های ممکن برای اشتراک.

انوم‌ها
STATE_UNSPECIFIED مقدار پیش‌فرض. این مقدار استفاده نشده است.
ACTIVE اشتراک فعال است و می‌تواند رویدادها را دریافت و به نقطه پایانی اعلان خود ارسال کند.
SUSPENDED به دلیل وجود خطا، اشتراک قادر به دریافت رویدادها نیست. برای شناسایی خطا، به فیلد suspensionReason مراجعه کنید.
DELETED اشتراک حذف می‌شود.

نوع خطا

خطاهای احتمالی برای اشتراک.

انوم‌ها
ERROR_TYPE_UNSPECIFIED مقدار پیش‌فرض. این مقدار استفاده نشده است.
USER_SCOPE_REVOKED کاربر مجاز، اعطای یک یا چند محدوده OAuth را لغو کرده است. برای کسب اطلاعات بیشتر در مورد مجوز برای Google Workspace، به پیکربندی صفحه رضایت OAuth مراجعه کنید.
APP_SCOPE_REVOKED مدیر دامنه، اعطای یک یا چند محدوده OAuth را برای برنامه لغو کرده است.
RESOURCE_DELETED منبع مورد نظر برای اشتراک دیگر وجود ندارد.
USER_AUTHORIZATION_FAILURE کاربری که ایجاد اشتراک را مجاز کرده است، دیگر به منبع هدف اشتراک دسترسی ندارد.
APP_AUTHORIZATION_FAILURE برنامه‌ای که ایجاد اشتراک را مجاز کرده بود، دیگر به منبع هدف اشتراک دسترسی ندارد.
ENDPOINT_PERMISSION_DENIED برنامه Google Workspace دسترسی لازم برای ارسال رویدادها به نقطه پایانی اعلان اشتراک شما را ندارد.
ENDPOINT_NOT_FOUND نقطه پایانی اعلان اشتراک وجود ندارد، یا نقطه پایانی در پروژه Google Cloud که اشتراک را در آن ایجاد کرده‌اید، یافت نمی‌شود.
ENDPOINT_RESOURCE_EXHAUSTED به دلیل سهمیه ناکافی یا رسیدن به محدودیت سرعت، نقطه پایانی اعلان اشتراک نتوانست رویدادها را دریافت کند.
OTHER خطایی نامشخص رخ داده است.

روش‌ها

create

 یک اشتراک Google Workspace ایجاد می‌کند.

delete

 اشتراک Google Workspace را حذف می‌کند.

get

 جزئیات مربوط به اشتراک Google Workspace را دریافت می‌کند.

list

 اشتراک‌های Google Workspace را فهرست می‌کند.

patch

 اشتراک Google Workspace را به‌روزرسانی یا تمدید می‌کند.

reactivate

 اشتراک Google Workspace که به حالت تعلیق درآمده بود را دوباره فعال می‌کند.