स्पेस अपडेट करना

इस गाइड में, Google Chat API के Space संसाधन पर patch तरीके का इस्तेमाल करके, किसी स्पेस को अपडेट करने का तरीका बताया गया है. किसी स्पेस के एट्रिब्यूट में बदलाव करने के लिए, उसे अपडेट करें. जैसे, उपयोगकर्ताओं को दिखने वाला डिसप्ले नेम, जानकारी, और दिशा-निर्देश.

अगर आप Google Workspace एडमिन हैं, तो patch तरीके को कॉल करके, अपने Google Workspace संगठन में मौजूद किसी भी स्पेस को अपडेट किया जा सकता है.

`Space` संसाधन, एक ऐसी जगह होती है जहां लोग और Chat ऐप्लिकेशन, मैसेज भेज सकते हैं, फ़ाइलें शेयर कर सकते हैं, और मिलकर काम कर सकते हैं.Space स्पेस कई तरह के होते हैं:

  • डायरेक्ट मैसेज (डीएम), दो उपयोगकर्ताओं या किसी उपयोगकर्ता और Chat ऐप्लिकेशन के बीच की बातचीत होती है.
  • ग्रुप चैट, तीन या इससे ज़्यादा उपयोगकर्ताओं और Chat ऐप्लिकेशन के बीच की बातचीत होती है.
  • नाम वाले स्पेस, ऐसी जगहें होती हैं जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और मिलकर काम करते हैं.

ज़रूरी शर्तें

Node.js

Python

Java

Apps Script

उपयोगकर्ता के तौर पर किसी स्पेस को अपडेट करना

Google Chat में मौजूद किसी स्पेस को उपयोगकर्ता की पुष्टि करने की सुविधाके साथ अपडेट करने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

  • chat.spaces के लिए अनुमति पाने का लिंक तय करें.
  • तरीके को कॉल करें.UpdateSpace अपने अनुरोध में, स्पेस का name फ़ील्ड, अपडेट किए जाने वाले एक या उससे ज़्यादा फ़ील्ड के साथ updateMask फ़ील्ड, और अपडेट की गई स्पेस की जानकारी के साथ body तय करें.

डिसप्ले नेम, स्पेस का टाइप, इतिहास की स्थिति वगैरह को अपडेट किया जा सकता है. अपडेट किए जा सकने वाले सभी फ़ील्ड देखने के लिए, रेफ़रंस दस्तावेज़ देखें.

यहां, मौजूदा स्पेस के displayName फ़ील्ड को अपडेट करने का तरीका बताया गया है:

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

await main();

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

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

इस सैंपल को चलाने के लिए, SPACE_NAME की जगह स्पेस के name फ़ील्ड से मिला आईडी डालें. `ListSpaces` ListSpaces तरीके को कॉल करके या स्पेस के यूआरएल से आईडी पाया जा सकता है.

Google Chat API, Space का एक इंस्टेंस दिखाता है, जिसमें अपडेट दिखते हैं.

Google Workspace एडमिन के तौर पर किसी स्पेस को अपडेट करना

अगर आप Google Workspace एडमिन हैं, तो UpdateSpace तरीके को कॉल करके, अपने Google Workspace संगठन में मौजूद किसी भी स्पेस को अपडेट किया जा सकता है.

Google Workspace एडमिन के तौर पर इस तरीके को कॉल करने के लिए, यह तरीका अपनाएं:

  • उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल करके, इस तरीके को कॉल करें. साथ ही, अनुमति पाने का ऐसा लिंक तय करें जिसकी मदद से, एडमिन के अधिकारोंका इस्तेमाल करके इस तरीके को कॉल किया जा सके.
  • अपने अनुरोध में, क्वेरी पैरामीटर useAdminAccess को true पर सेट करें.

ज़्यादा जानकारी और उदाहरणों के लिए, Google Workspace एडमिन के तौर पर Google Chat स्पेस मैनेज करना लेख पढ़ें.

Chat ऐप्लिकेशन के तौर पर किसी स्पेस को अपडेट करना

ऐप्लिकेशन की पुष्टि करने के लिए, एडमिन की अनुमति सिर्फ़ एक बार लेनी होती है .

Google Chat में मौजूद किसी स्पेस को ऐप्लिकेशन की पुष्टि करने की सुविधाके साथ अपडेट करने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

  • chat.app.spaces के लिए अनुमति पाने का लिंक तय करें. ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ, सिर्फ़ Chat ऐप्लिकेशन से बनाए गए स्पेस को अपडेट किया जा सकता है.
  • `Space` संसाधन पर ` patch` तरीके को कॉल करें. अपने अनुरोध में, स्पेस का name फ़ील्ड, अपडेट किए जाने वाले एक या उससे ज़्यादा फ़ील्ड के साथ updateMask फ़ील्ड, और अपडेट की गई स्पेस की जानकारी के साथ body तय करें.

डिसप्ले नेम, स्पेस का टाइप, इतिहास की स्थिति, अनुमति की सेटिंग वगैरह को अपडेट किया जा सकता है. अपडेट किए जा सकने वाले सभी फ़ील्ड देखने के लिए, रेफ़रंस दस्तावेज़ देखें.

Chat API को कॉल करने वाला स्क्रिप्ट लिखना

यहां, मौजूदा स्पेस के spaceDetails फ़ील्ड को अपडेट करने का तरीका बताया गया है:

Python

  1. अपनी वर्किंग डायरेक्ट्री में, chat_space_update_app.py नाम की एक फ़ाइल बनाएं.

  2. chat_space_update_app.py में यह कोड शामिल करें:

    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)

    # 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. कोड में, इन्हें बदलें:

  4. अपनी वर्किंग डायरेक्ट्री में, सैंपल बनाएं और चलाएं:

    python3 chat_space_update_app.py

Google Chat API, Space संसाधन का एक इंस्टेंस दिखाता है, जिसमें अपडेट दिखते हैं.

सीमाएं और ज़रूरी बातें