इंटरैक्टिव कार्ड बनाना और उन्हें अपडेट करना

इस गाइड में, Google Chat API का इस्तेमाल करके, उपयोगकर्ताओं की ओर से इंटरैक्टिव कार्ड वाले मैसेज बनाने का तरीका बताया गया है. साथ ही, उन कार्ड को एसिंक्रोनस तरीके से अपडेट करने का तरीका भी बताया गया है.

कार्ड बनाने और उन्हें अपडेट करने से, ये काम किए जा सकते हैं:

  • किसी उपयोगकर्ता की ओर से, किसी टास्क या बाहरी संसाधन को दिखाने वाला कार्ड पोस्ट करना.
  • उपयोगकर्ता की इंटरैक्शन का इंतज़ार किए बिना, बाहरी इवेंट के आधार पर कार्ड की स्थिति को अपडेट करना (उदाहरण के लिए, "जारी है" से "पूरा हो गया").
  • उपयोगकर्ता के मैसेज में मौजूद कार्ड के कॉन्टेंट को रीफ़्रेश करना. जैसे, लिंक की झलक.

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

Node.js

Python

Java

Apps Script

किसी उपयोगकर्ता की ओर से कार्ड मैसेज बनाना

किसी उपयोगकर्ता की ओर से कार्ड वाला मैसेज बनाने के लिए, उपयोगकर्ता की पुष्टि का इस्तेमाल करें.

मैसेज बनाने के लिए, अपने अनुरोध में यह जानकारी दें:

  • chat.messages.create या chat.messages अनुमति का दायरा.
  • Message संसाधन में मौजूद cardsV2 फ़ील्ड, जिसमें कार्ड का डेटा शामिल है.
  • हर कार्ड के लिए cardId, जो एसिंक्रोनस अपडेट के लिए ज़रूरी है.

यहां दिए गए उदाहरण में, किसी उपयोगकर्ता की ओर से कार्ड वाला मैसेज बनाने का तरीका बताया गया है:

Node.js

/**
 * This sample shows how to create a message with a card on behalf of a user.
 */
const {google} = require('googleapis');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client
  const authClient = await auth.getClient({
    scopes: ['https://www.googleapis.com/auth/chat.messages.create']
  });
  google.options({auth: authClient});

  // Initialize the Chat API
  const chat = google.chat({version: 'v1'});

  // The space to create the message in.
  const parent = 'spaces/SPACE_NAME';

  // Create the request
  const request = {
    parent: parent,
    requestBody: {
      text: 'Here is a card created on my behalf:',
      cardsV2: [{
        cardId: 'unique-card-id',
        card: {
          header: {
            title: 'Card Title',
            subtitle: 'Card Subtitle'
          },
          sections: [{
            widgets: [{
              textParagraph: {
                text: 'This card is attached to a user message.'
              }
            }]
          }]
        }
      }]
    }
  };

  // Call the API
  const response = await chat.spaces.messages.create(request);

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

main().catch(console.error);

Python

"""
This sample shows how to create a message with a card on behalf of a user.
"""
from google.oauth2 import service_account
from googleapiclient.discovery import build
import google.auth

def create_message_with_card():
    # Create a client
    scopes = ["https://www.googleapis.com/auth/chat.messages.create"]
    credentials, _ = google.auth.default(scopes=scopes)

    # Build the service endpoint for Chat API.
    service = build('chat', 'v1', credentials=credentials)

    # The space to create the message in.
    parent = "spaces/SPACE_NAME"

    # Create the request
    result = service.spaces().messages().create(
        parent=parent,
        body={
            'text': 'Here is a card created on my behalf:',
            'cardsV2': [{
                'cardId': 'unique-card-id',
                'card': {
                    'header': {
                        'title': 'Card Title',
                        'subtitle': 'Card Subtitle'
                    },
                    'sections': [{
                        'widgets': [{
                            'textParagraph': {
                                'text': 'This card is attached to a user message.'
                            }
                        }]
                    }]
                }
            }]
        }
    ).execute()

    print(result)

if __name__ == "__main__":
    create_message_with_card()

Java

/**
 * This sample shows how to create a message with a card on behalf of a user.
 */
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.gson.GsonFactory;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

public class CreateMessageWithCard {
  public static void main(String[] args) throws Exception {
    HttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
    GsonFactory jsonFactory = GsonFactory.getDefaultInstance();

    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList("https://www.googleapis.com/auth/chat.messages.create"));
    HttpRequestFactory requestFactory = transport.createRequestFactory(new HttpCredentialsAdapter(credentials));

    String parent = "spaces/SPACE_NAME";
    GenericUrl url = new GenericUrl("https://chat.googleapis.com/v1/" + parent + "/messages");

    // Construct the message body
    Map<String, Object> message = new HashMap<>();
    message.put("text", "Here is a card created on my behalf:");

    Map<String, Object> header = new HashMap<>();
    header.put("title", "Card Title");
    header.put("subtitle", "Card Subtitle");

    Map<String, Object> textParagraph = new HashMap<>();
    textParagraph.put("text", "This card is attached to a user message.");

    Map<String, Object> widget = new HashMap<>();
    widget.put("textParagraph", textParagraph);

    Map<String, Object> section = new HashMap<>();
    section.put("widgets", Collections.singletonList(widget));

    Map<String, Object> card = new HashMap<>();
    card.put("header", header);
    card.put("sections", Collections.singletonList(section));

    Map<String, Object> cardWithId = new HashMap<>();
    cardWithId.put("cardId", "unique-card-id");
    cardWithId.put("card", card);

    message.put("cardsV2", Collections.singletonList(cardWithId));

    HttpRequest request = requestFactory.buildPostRequest(url, new JsonHttpContent(jsonFactory, message));
    System.out.println(request.execute().parseAsString());
  }
}

Apps Script

/**
 * This sample shows how to create a message with a card on behalf of a user.
 */
function createMessageWithCard() {
  const parent = 'spaces/SPACE_NAME';
  const url = `https://chat.googleapis.com/v1/${parent}/messages`;

  const message = {
    text: 'Here is a card created on my behalf:',
    cardsV2: [{
      cardId: 'unique-card-id',
      card: {
        header: {
          title: 'Card Title',
          subtitle: 'Card Subtitle'
        },
        sections: [{
          widgets: [{
            textParagraph: {
              text: 'This card is attached to a user message.'
            }
          }]
        }]
      }
    }]
  };

  const options = {
    method: 'post',
    headers: {
      Authorization: 'Bearer ' + ScriptApp.getOAuthToken()
    },
    contentType: 'application/json',
    payload: JSON.stringify(message),
    muteHttpExceptions: true
  };

  try {
    const response = UrlFetchApp.fetch(url, options);
    console.log(response.getContentText());
  } catch (err) {
    console.log('Failed to create message: ' + err.message);
  }
}

कार्ड को एसिंक्रोनस तरीके से अपडेट करना

कार्ड वाला मैसेज बनाने के बाद, ऐप्लिकेशन की पुष्टि का इस्तेमाल करके, कार्ड को एसिंक्रोनस तरीके से अपडेट किया जा सकता है. इससे आपका ऐप्लिकेशन, उपयोगकर्ता के इंटरैक्शन के बिना कार्ड के कॉन्टेंट को रीफ़्रेश कर सकता है. उपयोगकर्ता के मैसेज में कार्ड जोड़ने वाला Chat ऐप्लिकेशन ही उसे बदल सकता है. अगर कोई उपयोगकर्ता मैसेज के टेक्स्ट में बदलाव करता है, तो ऐप्लिकेशन के मालिकाना हक वाले कार्ड हटा दिए जाते हैं. साथ ही, आपका ऐप्लिकेशन उन्हें अपडेट नहीं कर सकता.

कार्ड अपडेट करने के लिए, replaceCards तरीके को कॉल करें. इसके लिए, यह जानकारी दें:

  • chat.bot अनुमति का दायरा.
  • अपडेट किए जाने वाले मैसेज का name.
  • cardsV2 की नई सूची. इससे मैसेज में मौजूद सभी कार्ड बदल जाते हैं. अगर आपने खाली सूची दी है, तो कार्ड हटा दिए जाएंगे.

यहां दिए गए उदाहरण में, किसी मैसेज के कार्ड अपडेट करने का तरीका बताया गया है:

Node.js

/**
 * This sample shows how to update cards on a message.
 */
const {google} = require('googleapis');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client with app credentials
  const authClient = await auth.getClient({
    scopes: ['https://www.googleapis.com/auth/chat.bot']
  });
  google.options({auth: authClient});

  // Initialize the Chat API
  const chat = google.chat({version: 'v1'});

  // The message to update.
  const messageName = 'spaces/SPACE_NAME/messages/MESSAGE_ID';

  // Create the request
  const request = {
    name: messageName,
    requestBody: {
      cardsV2: [{
        cardId: 'unique-card-id',
        card: {
          header: {
            title: 'Updated Card Title',
            subtitle: 'Updated Card Subtitle'
          },
          sections: [{
            widgets: [{
              textParagraph: {
                text: 'The card content has been updated asynchronously.'
              }
            }]
          }]
        }
      }]
    }
  };

  // Call the API
  await chat.spaces.messages.replaceCards(request);
  console.log('Cards updated.');
}

main().catch(console.error);

Python

"""
This sample shows how to update cards on a message.
"""
from google.oauth2 import service_account
from googleapiclient.discovery import build
import google.auth

def replace_message_cards():
    # Create a client with app credentials
    scopes = ["https://www.googleapis.com/auth/chat.bot"]
    credentials, _ = google.auth.default(scopes=scopes)

    # Build the service endpoint for Chat API.
    service = build('chat', 'v1', credentials=credentials)

    # The message to update.
    message_name = "spaces/SPACE_NAME/messages/MESSAGE_ID"

    # Create the request
    result = service.spaces().messages().replaceCards(
        name=message_name,
        body={
            'cardsV2': [{
                'cardId': 'unique-card-id',
                'card': {
                    'header': {
                        'title': 'Updated Card Title',
                        'subtitle': 'Updated Card Subtitle'
                    },
                    'sections': [{
                        'widgets': [{
                            'textParagraph': {
                                'text': 'The card content has been updated asynchronously.'
                            }
                        }]
                    }]
                }
            }]
        }
    ).execute()

    print("Cards updated.")

if __name__ == "__main__":
    replace_message_cards()

Java

/**
 * This sample shows how to update cards on a message.
 */
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.gson.GsonFactory;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

public class ReplaceMessageCards {
  public static void main(String[] args) throws Exception {
    HttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
    GsonFactory jsonFactory = GsonFactory.getDefaultInstance();

    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList("https://www.googleapis.com/auth/chat.bot"));
    HttpRequestFactory requestFactory = transport.createRequestFactory(new HttpCredentialsAdapter(credentials));

    String messageName = "spaces/SPACE_NAME/messages/MESSAGE_ID";
    GenericUrl url = new GenericUrl("https://chat.googleapis.com/v1/" + messageName + ":replaceCards");

    // Construct the body
    Map<String, Object> header = new HashMap<>();
    header.put("title", "Updated Card Title");
    header.put("subtitle", "Updated Card Subtitle");

    Map<String, Object> textParagraph = new HashMap<>();
    textParagraph.put("text", "The card content has been updated asynchronously.");

    Map<String, Object> widget = new HashMap<>();
    widget.put("textParagraph", textParagraph);

    Map<String, Object> section = new HashMap<>();
    section.put("widgets", Collections.singletonList(widget));

    Map<String, Object> card = new HashMap<>();
    card.put("header", header);
    card.put("sections", Collections.singletonList(section));

    Map<String, Object> cardWithId = new HashMap<>();
    cardWithId.put("cardId", "unique-card-id");
    cardWithId.put("card", card);

    Map<String, Object> body = new HashMap<>();
    body.put("cardsV2", Collections.singletonList(cardWithId));

    HttpRequest request = requestFactory.buildPostRequest(url, new JsonHttpContent(jsonFactory, body));
    request.execute();
    System.out.println("Cards updated.");
  }
}

Apps Script

/**
 * This sample shows how to update cards on a message.
 */
function replaceMessageCards() {
  const messageName = 'spaces/SPACE_NAME/messages/MESSAGE_ID';
  const url = `https://chat.googleapis.com/v1/${messageName}:replaceCards`;

  const request = {
    cardsV2: [{
      cardId: 'unique-card-id',
      card: {
        header: {
          title: 'Updated Card Title',
          subtitle: 'Updated Card Subtitle'
        },
        sections: [{
          widgets: [{
            textParagraph: {
              text: 'The card content has been updated asynchronously.'
            }
          }]
        }]
      }
    }]
  };

  const options = {
    method: 'post',
    headers: {
      Authorization: 'Bearer ' + ScriptApp.getOAuthToken()
    },
    contentType: 'application/json',
    payload: JSON.stringify(request),
    muteHttpExceptions: true
  };

  try {
    const response = UrlFetchApp.fetch(url, options);
    console.log('Cards updated.');
  } catch (err) {
    console.log('Failed to update cards: ' + err.message);
  }
}

सीमाएं

  • किसी उपयोगकर्ता की ओर से कार्ड वाले मैसेज बनाते समय या कार्ड अपडेट करते समय, Chat ऐप्लिकेशन को स्पेस का सदस्य होना चाहिए. यह ज़रूरी शर्त तब लागू होती है, जब:

    यह ज़रूरी शर्त, उपयोगकर्ता की पुष्टि करने वाले अन्य एपीआई से अलग है. आम तौर पर, उन एपीआई के लिए यह ज़रूरी नहीं होता कि ऐप्लिकेशन उस स्पेस का सदस्य हो.

  • replaceCards तरीके का इस्तेमाल करके, कार्ड बदले और हटाए जा सकते हैं. साथ ही, कार्ड बदलते समय अतिरिक्त कार्ड जोड़े जा सकते हैं. हालांकि, ऐसे मैसेज में कार्ड नहीं जोड़े जा सकते जिसमें पहले से कार्ड मौजूद न हों.

  • चैट ऐप्लिकेशन सिर्फ़ उन कार्ड को बदल सकता है जिन्हें उसने किसी मैसेज में अटैच किया है. वह दूसरे चैट ऐप्लिकेशन से अटैच किए गए कार्ड नहीं बदल सकता.

  • अगर कोई उपयोगकर्ता मैसेज के टेक्स्ट में बदलाव करता है, तो Chat ऐप्लिकेशन के मालिकाना हक वाले कार्ड हटा दिए जाते हैं. इसके बाद, उन्हें अपडेट नहीं किया जा सकता.