Управление доступностью пользователей для чат-приложений

В этом руководстве объясняется, как использовать API Google 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);
  }
}

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);
  }
}

API чата обновляет и возвращает экземпляр объекта Availability с новым пользовательским статусом.

Чтобы удалить пользовательский статус, обновите доступность и пропустите сведения customStatus .

Обновить состояние присутствия

В зависимости от состояния присутствия целевого объекта, вы можете обновить доступность пользователя, вызвав один из следующих пользовательских методов:

  • Активный : Вызовите метод MarkAsActive , чтобы установить статус присутствия в активное состояние. Можно указать необязательные значения времени истечения срока действия ( ttl или expireTime ).
  • Отсутствует : вызовите метод MarkAsAway , чтобы установить статус присутствия как «Отсутствует».
  • Режим «Не беспокоить» : вызовите метод MarkAsDoNotDisturb , чтобы отключить уведомления.

Подробную информацию, включая описания полей и шаблоны запросов, см. в справочном руководстве по каждому методу.

Выявление изменений в доступности в результате события

Ваше приложение для чата может подписаться на события google.workspace.chat.availability.v1.updated , чтобы получать уведомления об изменении доступности пользователя. При обновлении доступности приложение получает событие с полезной нагрузкой, содержащей ресурс Availability .