管理 Chat 擴充應用程式的使用者存取權

本指南說明如何使用 Google Chat API 管理使用者的空閒狀態和自訂狀態。

如要讀取及更新 Chat 使用者的可用性，應用程式必須透過使用者驗證進行驗證。 系統只會允許存取或修改通過驗證的使用者空檔。

必要條件

Node.js

Python

Java

Apps Script

取得使用者的空閒時間

如要讀取 Google Chat 使用者的狀態，請在要求中傳遞下列項目：

  • 指定 chat.users.availability.readonly 或 chat.users.availability 授權範圍。
  • 呼叫 GetAvailability 方法。
  • 傳遞要擷取的供應情形資源 name。名稱的格式必須為 users/{user}/availability。使用者的電子郵件地址或me別名可用於參照來電者。例如 users/me/availability。

如何取得使用者的空閒時間：

Node.js

const { ChatServiceClient } = require('@google-apps/chat').v1;

// Instantiates a client
const chatServiceClient = new ChatServiceClient();

async function getAvailability() {
  const request = {
    // The name of the availability resource to retrieve.
    // Format: users/{user}/availability
    // The 'me' alias can be used to refer to the calling user.
    name: 'users/me/availability',
  };

  try {
    const response = await chatServiceClient.getAvailability(request);
    console.log(response);
  } catch (err) {
    console.error('Error retrieving availability:', err);
  }
}

getAvailability();

Python

from google.apps import chat_v1 as google_chat

def get_availability():
    # Instantiates a client
    client = google_chat.ChatServiceClient()

    # Prepare request
    request = google_chat.GetAvailabilityRequest(
        # Format: users/{user}/availability
        # The 'me' alias refers to the calling user.
        name="users/me/availability",
    )

    # Call the API
    try:
        response = client.get_availability(request=request)
        print(response)
    except Exception as e:
        print(f"Error retrieving availability: {e}")

get_availability()

Java

import com.google.chat.v1.Availability;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetAvailabilityRequest;

public class GetAvailability {
  public static void main(String[] args) throws Exception {
    // Instantiates a client
    try (ChatServiceClient chatServiceClient = ChatServiceClient.create()) {
      GetAvailabilityRequest request = GetAvailabilityRequest.newBuilder()
          // Format: users/{user}/availability
          // The 'me' alias refers to the calling user.
          .setName("users/me/availability")
          .build();

      Availability response = chatServiceClient.getAvailability(request);
      System.out.println(response);
    }
  }
}

Apps Script

/**
 * Retrieves the calling user's availability details.
 */
function getUserAvailability() {
  const name = 'users/me/availability';
  try {
    const availability = Chat.Users.Availability.get(name);
    console.log(availability);
  } catch (err) {
    console.error('Failed to get availability: ' + err.message);
  }
}

Chat API 會傳回 Availability 的例項，詳細說明使用者的在線狀態和自訂狀態。

更新自訂狀態

如要更新使用者的自訂狀態，請在要求中傳遞下列項目：

  • 指定 chat.users.availability 授權範圍。
  • 呼叫 UpdateAvailability 方法。
  • 傳遞 Availability 資源，並指定新的 customStatus 詳細資料。
  • 設定 update_mask 參數，加入 custom_status 欄位。

如要更新使用者的自訂狀態，請按照下列步驟操作：

Node.js

const { ChatServiceClient } = require('@google-apps/chat').v1;

// Instantiates a client
const chatServiceClient = new ChatServiceClient();

async function updateCustomStatus() {
  const request = {
    // The Availability resource to update.
    availability: {
      name: 'users/me/availability',
      customStatus: {
        text: 'In a meeting',
        emoji: {
          unicode: '📅'
        }
      }
    },
    // The fields to update. Must contain 'custom_status'.
    updateMask: {
      paths: ['custom_status']
    }
  };

  try {
    const response = await chatServiceClient.updateAvailability(request);
    console.log(response);
  } catch (err) {
    console.error('Error updating status:', err);
  }
}

updateCustomStatus();

Python

from google.apps import chat_v1 as google_chat
from google.protobuf import field_mask_pb2

def update_custom_status():
    # Instantiates a client
    client = google_chat.ChatServiceClient()

    # Define custom status and emoji
    custom_status = google_chat.CustomStatus(
        text="In a meeting",
        emoji=google_chat.Emoji(unicode="📅")
    )

    # Initialize availability object
    availability = google_chat.Availability(
        name="users/me/availability",
        custom_status=custom_status
    )

    # Specify update mask
    update_mask = field_mask_pb2.FieldMask(paths=["custom_status"])

    # Prepare request
    request = google_chat.UpdateAvailabilityRequest(
        availability=availability,
        update_mask=update_mask
    )

    # Call the API
    try:
        response = client.update_availability(request=request)
        print(response)
    except Exception as e:
        print(f"Error updating status: {e}")

update_custom_status()

Java

import com.google.chat.v1.Availability;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CustomStatus;
import com.google.chat.v1.Emoji;
import com.google.chat.v1.UpdateAvailabilityRequest;
import com.google.protobuf.FieldMask;

public class UpdateCustomStatus {
  public static void main(String[] args) throws Exception {
    // Instantiates a client
    try (ChatServiceClient chatServiceClient = ChatServiceClient.create()) {
      CustomStatus customStatus = CustomStatus.newBuilder()
          .setText("In a meeting")
          .setEmoji(Emoji.newBuilder().setUnicode("📅"))
          .build();

      Availability availability = Availability.newBuilder()
          .setName("users/me/availability")
          .setCustomStatus(customStatus)
          .build();

      FieldMask updateMask = FieldMask.newBuilder()
          .addPaths("custom_status")
          .build();

      UpdateAvailabilityRequest request = UpdateAvailabilityRequest.newBuilder()
          .setAvailability(availability)
          .setUpdateMask(updateMask)
          .build();

      Availability response = chatServiceClient.updateAvailability(request);
      System.out.println(response);
    }
  }
}

Apps Script

/**
 * Updates the calling user's custom status message.
 */
function updateCustomStatus() {
  const name = 'users/me/availability';
  const availability = {
    customStatus: {
      text: 'In a meeting',
      emoji: {
        unicode: '📅'
      }
    }
  };
  const updateMask = 'custom_status';

  try {
    const response = Chat.Users.Availability.patch(availability, name, {
      updateMask: updateMask
    });
    console.log(response);
  } catch (err) {
    console.error('Failed to update status: ' + err.message);
  }
}

Chat API 會更新並傳回 Availability 的例項，其中包含新的自訂狀態。

如要清除使用者的自訂狀態，請更新有空與否狀態，並省略 customStatus 詳細資料。

更新在場狀態

視目標在場狀態而定，您可以呼叫下列其中一種自訂方法，更新使用者的空閒狀態：

  • 有效：呼叫 MarkAsActive 方法，將狀態設為有效。可選擇提供到期值 (ttl 或 expireTime)。
  • 離開：呼叫 MarkAsAway 方法，將狀態設為離開。
  • 零打擾：呼叫 MarkAsDoNotDisturb 方法，將通知設為靜音。

如需欄位說明和查詢範本等詳細資料，請參閱各方法的參考指南。

從活動中找出空房情況變化

Chat 應用程式可以訂閱 google.workspace.chat.availability.v1.updated 事件，在使用者狀態變更時收到通知。當供應情形更新時，應用程式會收到含有 Availability 資源的事件。