Method: subscriptions.patch

Google Workspace サブスクリプションを更新または更新します。この方法の使用方法については、Google Workspace サブスクリプションを更新するをご覧ください。

HTTP リクエスト

PATCH https://workspaceevents.googleapis.com/v1/{subscription.name=subscriptions/*}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
subscription.name

string

ID。サブスクリプションのリソース名。

形式: subscriptions/{subscription}

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

省略可。更新するフィールド。省略した場合は、リクエストに含まれるすべてのフィールドが更新されます。

サブスクリプションで更新できるフィールドは次のいずれかです。

  • expireTime: サブスクリプションが期限切れになるタイムスタンプ。
  • ttl: サブスクリプションの有効期間（TTL）または期間。
  • eventTypes: ターゲット リソースに関するイベントタイプのリスト。

サブスクリプションを完全に置き換える（PUT と同等）には、* を使用します。省略されたフィールドは空の値で更新されます。
validateOnly

boolean

省略可。true に設定すると、リクエストを検証してプレビューしますが、サブスクリプションは更新されません。

リクエスト本文

リクエストの本文には Subscription のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

  • metadata フィールドに空の配列が含まれています。
  • response フィールドには、Subscription の更新されたインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

詳しくは、認可ガイドをご覧ください。