ইন্টারেক্টিভ কার্ড তৈরি এবং আপডেট করুন

এই নির্দেশিকায় ব্যাখ্যা করা হয়েছে কীভাবে গুগল চ্যাট এপিআই ব্যবহার করে ব্যবহারকারীদের পক্ষ থেকে ইন্টারেক্টিভ কার্ড সম্বলিত বার্তা তৈরি করা যায় এবং কীভাবে সেই কার্ডগুলিকে অ্যাসিঙ্ক্রোনাসভাবে আপডেট করা যায়।

নিম্নলিখিত কাজগুলো করার জন্য কার্ড তৈরি ও আপডেট করা উপযোগী:

  • কোনো ব্যবহারকারীর পক্ষ থেকে একটি কাজ বা বাহ্যিক উৎসের প্রতিনিধিত্বকারী একটি কার্ড পোস্ট করুন।
  • ব্যবহারকারীর কোনো ইন্টারঅ্যাকশনের জন্য অপেক্ষা না করে, বাহ্যিক ইভেন্টের উপর ভিত্তি করে কার্ডের স্ট্যাটাস আপডেট করুন (উদাহরণস্বরূপ, "চলমান" থেকে "সম্পন্ন")।
  • ব্যবহারকারীর বার্তায় থাকা কোনো কার্ডের বিষয়বস্তু রিফ্রেশ করুন, যেমন লিঙ্ক প্রিভিউ।

ডেভেলপার প্রিভিউ প্রোগ্রামের বাইরে, ব্যবহারকারী প্রমাণীকরণের মাধ্যমে তৈরি বার্তাগুলিতে শুধুমাত্র টেক্সট থাকতে পারে।

পূর্বশর্ত

নোড.জেএস

পাইথন

জাভা

অ্যাপস স্ক্রিপ্ট

ডেভেলপার প্রিভিউ ফিচারগুলো অ্যাক্সেস করতে একটি এপিআই কী তৈরি করুন

ডেভেলপার প্রিভিউ এপিআই মেথড কল করতে হলে, আপনাকে অবশ্যই এপিআই ডিসকভারি ডকুমেন্টের একটি নন-পাবলিক ডেভেলপার প্রিভিউ সংস্করণ ব্যবহার করতে হবে। অনুরোধটি প্রমাণীকরণের জন্য, আপনাকে একটি এপিআই কী প্রদান করতে হবে।

এপিআই কী (API Key) তৈরি করতে, আপনার অ্যাপের গুগল ক্লাউড প্রজেক্টটি খুলুন এবং নিম্নলিখিত পদক্ষেপগুলো অনুসরণ করুন:

  1. গুগল ক্লাউড কনসোলে, > এপিআই ও পরিষেবা > ক্রেডেনশিয়ালস- এ যান।

    পরিচয়পত্রে যান

  2. ক্রেডেনশিয়াল তৈরি করুন > এপিআই কী-তে ক্লিক করুন।
  3. আপনার নতুন এপিআই কী প্রদর্শিত হচ্ছে।
    • আপনার অ্যাপের কোডে ব্যবহারের জন্য আপনার এপিআই কী (API key) কপি করতে 'Copy তে ক্লিক করুন। এপিআই কী-টি আপনার প্রোজেক্টের ক্রেডেনশিয়ালস (credentials)-এর 'API Keys' সেকশনেও পাওয়া যাবে।
    • অননুমোদিত ব্যবহার রোধ করতে, আমরা এপিআই কী কোথায় এবং কোন কোন এপিআই-এর জন্য ব্যবহার করা যাবে তা সীমাবদ্ধ করার সুপারিশ করি। আরও বিস্তারিত জানতে, ‘এপিআই সীমাবদ্ধতা যোগ করুন ’ দেখুন।

একজন ব্যবহারকারীর পক্ষ থেকে একটি কার্ড বার্তা তৈরি করুন

কোনো ব্যবহারকারীর পক্ষ থেকে কার্ডসহ বার্তা তৈরি করতে, ব্যবহারকারী প্রমাণীকরণ ব্যবহার করুন।

বার্তাটি তৈরি করতে, আপনার অনুরোধে নিম্নলিখিত বিষয়গুলো উল্লেখ করুন:

  • chat.messages.create অথবা chat.messages অনুমোদন পরিধি।
  • Message রিসোর্সের অন্তর্গত cardsV2 ফিল্ড, যেখানে কার্ডের ডেটা থাকে।
  • প্রতিটি কার্ডের cardId , যা অ্যাসিঙ্ক্রোনাস আপডেটের জন্য প্রয়োজন।

নিম্নলিখিত উদাহরণটি দেখায় কিভাবে একজন ব্যবহারকারীর পক্ষ থেকে কার্ড সহ একটি বার্তা তৈরি করতে হয়:

নোড.জেএস 

/**
 * 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 with Developer Preview labels
  const chat = await google.discoverAPI(
    'https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY'
  );

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

পাইথন 

"""
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 with Developer Preview labels.
    service = build(
        'chat',
        'v1',
        credentials=credentials,
        discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY'
    )

    # 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()

জাভা 

/**
 * 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());
  }
}

অ্যাপস স্ক্রিপ্ট 

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

অ্যাসিঙ্ক্রোনাসভাবে কার্ডগুলি আপডেট করুন

কার্ডসহ একটি মেসেজ তৈরি করার পর, আপনি অ্যাপ অথেন্টিকেশন ব্যবহার করে অ্যাসিঙ্ক্রোনাসভাবে কার্ডগুলো আপডেট করতে পারেন। এর ফলে আপনার অ্যাপ ব্যবহারকারীর কোনো ইন্টারঅ্যাকশন ছাড়াই কার্ডের বিষয়বস্তু রিফ্রেশ করতে পারে। শুধুমাত্র যে চ্যাট অ্যাপটি ব্যবহারকারীর মেসেজে কার্ডটি যুক্ত করেছে, সেটিই এটি প্রতিস্থাপন করতে পারে। যদি কোনো ব্যবহারকারী মেসেজের টেক্সট সম্পাদনা করেন, তাহলে অ্যাপের মালিকানাধীন কার্ডগুলো মুছে যায় এবং আপনার অ্যাপ সেগুলো আর আপডেট করতে পারে না।

কার্ডগুলো আপডেট করতে, নিম্নলিখিত তথ্যসহ replaceCards মেথডটি কল করুন:

  • chat.bot অনুমোদনের পরিধি।
  • যে বার্তাটি আপডেট করতে হবে তার name ।
  • নতুন cardsV2 তালিকা। এটি মেসেজে থাকা সমস্ত বিদ্যমান কার্ড প্রতিস্থাপন করে। আপনি যদি একটি খালি তালিকা প্রদান করেন, তাহলে কার্ডগুলি মুছে ফেলা হবে।

নিম্নলিখিত উদাহরণটি দেখায় কিভাবে একটি বার্তার কার্ডগুলি আপডেট করতে হয়:

নোড.জেএস 

/**
 * 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 with Developer Preview labels
  const chat = await google.discoverAPI(
    'https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY'
  );

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

পাইথন 

"""
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 with Developer Preview labels.
    service = build(
        'chat',
        'v1',
        credentials=credentials,
        discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY'
    )

    # 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()

জাভা 

/**
 * 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.");
  }
}

অ্যাপস স্ক্রিপ্ট 

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

সীমাবদ্ধতা

  • কোনো ব্যবহারকারীর পক্ষ থেকে কার্ডসহ বার্তা তৈরি করার সময় বা কার্ড আপডেট করার সময়, চ্যাট অ্যাপটিকে অবশ্যই স্পেসটির সদস্য হতে হবে। এই শর্তটি প্রযোজ্য হয় যখন:

    এই শর্তটি ব্যবহারকারী প্রমাণীকরণ ব্যবহারকারী অন্যান্য এপিআই থেকে ভিন্ন, যেগুলোর ক্ষেত্রে সাধারণত অ্যাপটিকে স্পেসটির সদস্য হওয়ার প্রয়োজন হয় না।

  • replaceCards মেথডটি কার্ড প্রতিস্থাপন এবং অপসারণ সমর্থন করে, এবং কার্ড প্রতিস্থাপন করার সময় আপনি অতিরিক্ত কার্ড যোগ করতে পারেন, কিন্তু যে মেসেজে আগে থেকেই কার্ড নেই, তাতে আপনি নতুন কার্ড যোগ করতে পারবেন না।

  • চ্যাট অ্যাপটি শুধুমাত্র নিজের দ্বারা মেসেজে সংযুক্ত কার্ডগুলোই প্রতিস্থাপন করতে পারে, অন্য কোনো চ্যাট অ্যাপের সংযুক্ত কার্ড নয়।

  • যদি কোনো ব্যবহারকারী বার্তার লেখা সম্পাদনা করেন, তাহলে চ্যাট অ্যাপের মালিকানাধীন কার্ডগুলো মুছে যায় এবং আপনি সেগুলো আর আপডেট করতে পারবেন না।