Aktualizowanie pokoju

Z tego przewodnika dowiesz się, jak korzystać z patch() w zasobie Space interfejsu Google Chat API, aby zaktualizować pokój. Zaktualizuj aby zmienić atrybuty pokoju, takie jak wyświetlana nazwa widoczna dla użytkowników opis i wytyczne.

Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę patch() , aby zaktualizować dowolny pokój w Twojej organizacji Google Workspace.

SpaceZasób to miejsce, w którym użytkownicy i aplikacje czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka typów pokoi:

  • Czaty to rozmowy między 2 użytkownikami lub użytkownikiem aplikacji do obsługi czatu.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami komunikatory;
  • Nazwane pokoje to stałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Wymagania wstępne

Node.js

Python

Java

Google Apps Script

Aktualizowanie pokoju przez użytkownika

Aby zaktualizować istniejący pokój w Google Chat za pomocą: user authentication, zaliczaj następujące elementy w żądaniu:

  • Określ zakres autoryzacji chat.spaces.
  • Wywołaj funkcję UpdateSpace() . W żądaniu musisz określić pole pokoju name, updateMask pole z co najmniej 1 polem do zaktualizowania oraz body ze zaktualizowanym miejscem i informacjami o nich.

Możesz zaktualizować wyświetlaną nazwę, typ pokoju, stan historii i inne informacje. Aby zobaczyć wszystkie pola, które możesz zaktualizować, zapoznaj się z dokumentacją.

Aby zaktualizować pole displayName w istniejącym pokoju:

Node.js

chat/client-libraries/cloud/update-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to update a space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    space: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

    # Make the request
    response = client.update_space(request)

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Google Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

Aby uruchomić ten przykład, zastąp wartość SPACE_NAME identyfikatorem z pola name w pokoju. Aby go uzyskać, wywołaj metodę ListSpaces() lub z adresu URL pokoju.

Interfejs Google Chat API zwraca instancję Space, która odzwierciedla aktualizacje.

Aktualizowanie pokoju jako administrator Google Workspace

Jeśli jesteś administratorem Google Workspace, możesz wywołać Metoda UpdateSpace(), aby zaktualizować dowolny pokój w Google Workspace Twojej organizacji.

Aby wywołać tę metodę jako administrator Google Workspace:

  • Wywołaj tę metodę za pomocą uwierzytelniania użytkownika i określ zakres autoryzacji który obsługuje wywoływanie metody za pomocą uprawnienia administratora.
  • W żądaniu określ parametr zapytania od useAdminAccess do true.

Więcej informacji i przykłady znajdziesz w artykule Zarządzanie pokojami Google Chat przez administratora Google Workspace.

Aktualizowanie pokoju jako aplikacji Google Chat

Aby uwierzytelnić aplikację, musisz jednorazowo zatwierdzić ją przez administratora.

Aby zaktualizować istniejący pokój w Google Chat za pomocą: uwierzytelnianie aplikacji, w swoim żądaniu:

  • Określ zakres autoryzacji chat.app.spaces. Po uwierzytelnieniu aplikacji możesz aktualizować tylko pokoje utworzone przez aplikacje Google Chat.
  • Wywołaj metodę patch zasobu Space. W należy określić pole pokoju name oraz updateMask z co najmniej jednym polem do zaktualizowania oraz body ze zaktualizowanymi informacjami o pokoju.

Możesz zaktualizować wyświetlaną nazwę, typ pokoju, stan historii, ustawienia uprawnień i inne. Aby zobaczyć wszystkie pola, które możesz zaktualizować, zobacz dokumentację referencyjną.

Tworzenie klucza interfejsu API

Aby wywołać metodę interfejsu API w wersji przedpremierowej dla programistów, musisz użyć niepublicznej wersji dokumentu wyszukiwania interfejsu API w wersji przedpremierowej dla programistów. Aby uwierzytelnić żądanie, musisz podać klucz interfejsu API.

Aby utworzyć klucz interfejsu API, otwórz projekt Google Cloud aplikacji i wykonaj te czynności:

  1. W konsoli Google Cloud kliknij Menu  > Interfejsy API i usługi > Dane logowania.

    Przejdź do danych logowania

  2. Kliknij Utwórz dane logowania > Klucz interfejsu API.
  3. Wyświetli się Twój nowy klucz interfejsu API.
    • Kliknij Kopiuj , aby skopiować klucz interfejsu API i użyć go w kodzie aplikacji. Kluczem interfejsu API może być również w „kluczach interfejsu API” danych logowania do projektu.
    • Kliknij Ogranicz klucz, aby zaktualizować ustawienia zaawansowane i ograniczyć użycie klucza API. Więcej informacji znajdziesz w artykule Stosowanie ograniczeń dotyczących kluczy interfejsu API.

Napisać skrypt, który wywołuje interfejs Chat API

Aby zaktualizować pole spaceDetails w istniejącym pokoju:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_update_app.py.

  2. Dodaj do pliku chat_space_update_app.py ten kod:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().patch(

      # The space to update, and the updated space details.
      #
      # Replace {space} with a space name.
      # Obtain the space name from the spaces resource of Chat API,
      # or from a space's URL.
      name='spaces/SPACE',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

    # Prints details about the updated space.
    print(result)

if __name__ == '__main__':
    main()

  3. Zastąp w kodzie następujące elementy:

    • API_KEY: klucz interfejsu API utworzony przez Ciebie na potrzeby kompilacji. punktu końcowego usługi Chat API.
    • SPACE z nazwą pokoju, którą możesz uzyskać z metody spaces.list w interfejsie API Google Chat lub z adresu URL pokoju.

  4. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_update_app.py

Interfejs Google Chat API zwraca instancję Space zasób przedstawiający aktualizacje.