ユーザーのスペースの通知設定を更新する

このガイドでは、Google Chat API の SpaceNotificationSetting リソースで patch() メソッドを使用して、 ユーザーのスペース通知設定を更新する方法について説明します。

SpaceNotificationSetting リソース は、指定したユーザーのスペース 通知設定の詳細を表すシングルトン リソースです。

前提条件

Node.js

• Google Chat にアクセスできる Business または Enterprise Google Workspace アカウント。

• 環境を設定します。
  • Google Cloud プロジェクトを作成します。
  • OAuth 同意画面を構成します。
  • Chat アプリの名前、 アイコン、説明を使用して Google Chat API を有効にして構成します。
  • Node.js 用 Cloud クライアント ライブラリをインストールします。
  • デスクトップ アプリケーションの OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を credentials.json という名前の JSON ファイルとしてローカル ディレクトリに保存します。
  手順については、この クイックスタートの環境設定の手順を完了してください。
• ユーザー認証をサポートする認証スコープを選択します。

このページのコードサンプルでは、Google Cloud クライアント ライブラリで gRPC API インターフェースを使用します。または、REST API インターフェースを使用することもできます。gRPC インターフェースと REST インターフェースの詳細については、 Google Chat API の概要をご覧ください。

呼び出し元のユーザーのスペース通知設定を更新する

ユーザーのスペース通知設定を更新するには、リクエストに次のものを含めます。

• chat.users.spacesettings 認証スコープを指定します。
• UpdateSpaceNotificationSetting() メソッドを呼び出し、通知設定の 変更を含む UpdateSpaceNotificationSetting リクエストを渡します。リクエストには次のものが含まれます。
  • spaceNotificationSetting 次のプロパティを持つ:
    • name プロパティは、更新するスペース通知設定を指定します。これには、ユーザー ID またはエイリアスとスペース ID が含まれます。スペース通知設定の更新では、呼び出し元のユーザーの通知設定の更新のみがサポートされます。これは、次のいずれかを設定することで指定できます。
      • me エイリアス。例: users/me/spaces/SPACE/spaceNotificationSetting。
      • 呼び出し元のユーザーの Workspace メールアドレス。例: users/[e-mail]/spaces/SPACE/spaceNotificationSetting。
      • 呼び出し元のユーザーのユーザー ID。例: users/USER/spaces/SPACE/spaceNotificationSetting。
    • notificationSetting: 通知レベルを設定します（ALL、OFF など）。
    • muteSetting: ミュートのオンまたはオフを設定します。値は MUTED または UNMUTED になります。
  • updateMask: 更新フィールドを設定します。notification_setting、mute_setting を含めることができます。

次の例では、呼び出し元のユーザーのスペース通知設定を更新します。

Node.js

chat/client-libraries/cloud/update-space-notification-setting-user-cred.js

GitHub で表示

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.spacesettings',
];

// This sample shows how to update the space notification setting for the
// calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s), replace the SPACE_NAME with an actual space
  // name.
  const request = {
    spaceNotificationSetting: {
      name: 'users/me/spaces/SPACE_NAME/spaceNotificationSetting',
      notificationSetting: 'ALL',
      muteSetting: 'UNMUTED',
    },
    updateMask: {paths: ['notification_setting', 'mute_setting']},
  };

  // Make the request
  const response = await chatClient.updateSpaceNotificationSetting(request);

  // Handle the response
  console.log(response);
}

await main();

このサンプルを実行するには、SPACE_NAME を スペースの nameから取得した ID に置き換えます。 ID は、 ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。

Google Chat API は、指定されたスペース通知設定を更新し、 an instance of SpaceNotificationSetting を返します。

関連トピック

• 呼び出し元のユーザーのスペース通知設定を取得する。