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

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

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

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

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

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

Node.js

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

Python

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

Java

  • आपके पास ऐसा Business या Enterprise Google Workspace खाता होना चाहिए जिसके पास Google Chat का ऐक्सेस हो.

Apps Script

  • आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो. साथ ही, आपके पास Google Chat का ऐक्सेस हो.

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

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

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

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() तरीका अपनाएं या स्पेस के यूआरएल का इस्तेमाल करें.

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

Google Workspace एडमिन के तौर पर, स्पेस में बदलाव करना

अगर आप Google Workspace एडमिन हैं, तो अपने Google Workspace संगठन के किसी भी स्पेस को अपडेट करने के लिए, UpdateSpace() तरीका अपनाएं.

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

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

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

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

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

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

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

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

एपीआई पासकोड बनाना

डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई के खोज से जुड़े दस्तावेज़ के ऐसे वर्शन का इस्तेमाल करना होगा जो सार्वजनिक तौर पर उपलब्ध न हो. अनुरोध की पुष्टि करने के लिए, आपको एक एपीआई पासकोड भेजना होगा.

एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:

  1. Google Cloud Console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें.
  3. आपको अपनी नई एपीआई कुंजी दिखेगी.
    • अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई पासकोड, प्रोजेक्ट के क्रेडेंशियल के "एपीआई पासकोड" सेक्शन में भी मिल सकता है.
    • बेहतर सेटिंग अपडेट करने और एपीआई पासकोड के इस्तेमाल को सीमित करने के लिए, पासकोड पर पाबंदी लगाएं पर क्लिक करें. ज़्यादा जानकारी के लिए, एपीआई पासकोड पर पाबंदियां लगाना लेख पढ़ें.

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, 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. कोड में, इनकी जगह ये डालें:

    • API_KEY: Chat API के लिए सेवा एंडपॉइंट बनाने के लिए, आपने जो एपीआई पासकोड बनाया है.
    • SPACE, जिसमें स्पेस का नाम शामिल हो. यह नाम, Chat API में spaces.list तरीके या स्पेस के यूआरएल से लिया जा सकता है.

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

    python3 chat_space_update_app.py

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