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

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

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

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

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

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

Node.js

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

Python

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

Java

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

Apps Script

  • आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास 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 संसाधन का एक इंस्टेंस दिखाता है.

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