Mesaj güncelleme

Bu kılavuzda, bir alandaki metin veya kart mesajını güncellemek için Google Chat API'nin Message kaynağındaki update() yönteminin nasıl kullanılacağı açıklanmaktadır. Bir mesajı güncelleyerek mesaj özelliklerini (ör. mesajın içeriği veya kartın içeriği) değiştirebilirsiniz. Kart mesajına metin mesajı ekleyebilir veya metin mesajına kart ekleyebilirsiniz.

Chat API'de Chat mesajları Message kaynağı ile temsil edilir. Chat kullanıcıları yalnızca metin içeren mesajlar gönderebilirken Chat uygulamaları statik veya etkileşimli kullanıcı arayüzleri gösterme, kullanıcılardan bilgi toplama ve mesajları gizli olarak yayınlama gibi birçok mesajlaşma özelliğini kullanabilir. Chat API'de kullanılabilen mesajlaşma özellikleri hakkında daha fazla bilgi edinmek için Google Chat mesajlarına genel bakış başlıklı makaleyi inceleyin.

Ön koşullar

Node.js

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.

• Ortamınızı ayarlayın:
  • Google Cloud projesi oluşturun.
  • OAuth izin ekranını yapılandırın.
  • Chat uygulamanız için bir ad, simge ve açıklamayla Google Chat API'yi etkinleştirip yapılandırın.
  • Node.js Cloud İstemci Kitaplığı'nı yükleyin.
  • Google Chat API isteğinizde kimliğinizi doğrulama yönteminize göre erişim kimlik bilgileri oluşturun:
    • Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgilerini oluşturun ve kimlik bilgilerini yerel dizininize client_secrets.json adlı bir JSON dosyası olarak kaydedin.
    • Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini credentials.json adlı bir JSON dosyası olarak kaydedin.
• Kullanıcı olarak mı yoksa Chat uygulaması olarak mı kimlik doğrulama yapmak istediğinize bağlı olarak bir yetkilendirme kapsamı seçin.

Python

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.

• Ortamınızı ayarlayın:
  • Google Cloud projesi oluşturun.
  • OAuth izin ekranını yapılandırın.
  • Chat uygulamanız için bir ad, simge ve açıklamayla Google Chat API'yi etkinleştirip yapılandırın.
  • Python Cloud İstemci Kitaplığı'nı yükleyin.
  • Google Chat API isteğinizde kimliğinizi doğrulama yönteminize göre erişim kimlik bilgileri oluşturun:
    • Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgilerini oluşturun ve kimlik bilgilerini yerel dizininize client_secrets.json adlı bir JSON dosyası olarak kaydedin.
    • Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini credentials.json adlı bir JSON dosyası olarak kaydedin.
• Kullanıcı olarak mı yoksa Chat uygulaması olarak mı kimlik doğrulama yapmak istediğinize bağlı olarak bir yetkilendirme kapsamı seçin.

Java

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.

• Ortamınızı ayarlayın:
  • Google Cloud projesi oluşturun.
  • OAuth izin ekranını yapılandırın.
  • Chat uygulamanız için bir ad, simge ve açıklamayla Google Chat API'yi etkinleştirip yapılandırın.
  • Java Cloud İstemci Kitaplığı'nı yükleyin.
  • Google Chat API isteğinizde kimliğinizi doğrulama yönteminize göre erişim kimlik bilgileri oluşturun:
    • Chat kullanıcısı olarak kimlik doğrulamak için OAuth istemci kimliği kimlik bilgilerini oluşturun ve kimlik bilgilerini yerel dizininize client_secrets.json adlı bir JSON dosyası olarak kaydedin.
    • Chat uygulaması olarak kimlik doğrulamak için hizmet hesabı kimlik bilgileri oluşturun ve kimlik bilgilerini credentials.json adlı bir JSON dosyası olarak kaydedin.
• Kullanıcı olarak mı yoksa Chat uygulaması olarak mı kimlik doğrulama yapmak istediğinize bağlı olarak bir yetkilendirme kapsamı seçin.

Apps Komut Dosyası

• Google Chat'e erişimi olan bir Business veya Enterprise Google Workspace hesabı.

• Ortamınızı ayarlayın:
  • Google Cloud projesi oluşturun.
  • OAuth izin ekranını yapılandırın.
  • Chat uygulamanız için bir ad, simge ve açıklamayla Google Chat API'yi etkinleştirip yapılandırın.
  • Bağımsız bir Apps Komut Dosyası projesi oluşturun ve Gelişmiş Chat Hizmeti'ni etkinleştirin.
  • Bu kılavuzda kullanıcı veya uygulama kimlik doğrulamasını kullanmanız gerekir. Sohbet uygulaması olarak kimlik doğrulama yapmak için hizmet hesabı kimlik bilgileri oluşturun. Adımlar için Google Chat uygulaması olarak kimlik doğrulama ve yetkilendirme başlıklı makaleyi inceleyin.
• Kullanıcı olarak mı yoksa Chat uygulaması olarak mı kimlik doğrulama yapmak istediğinize bağlı olarak bir yetkilendirme kapsamı seçin.

Bu sayfadaki kod örnekleri, Google Cloud istemci kitaplıklarıyla gRPC API arayüzünü kullanır. Alternatif olarak, REST API arayüzünü de kullanabilirsiniz. gRPC ve REST arayüzleri hakkında daha fazla bilgi için Google Chat API'ye genel bakış başlıklı makaleyi inceleyin.

Bir kullanıcı adına mesaj güncelleme

Kullanıcı kimlik doğrulaması ile yalnızca ileti metni güncellenebilir.

Bir iletiyi kullanıcı kimlik doğrulamasıyla güncellemek için isteğinizde aşağıdakileri iletin:

• chat.messages yetkilendirme kapsamını belirtin.
• UpdateMessage() yöntemini çağırın.
• message değerini, aşağıdakilerle birlikte Message örneği olarak iletin:
  • Güncellenecek iletiye ayarlanan name alanı. Alan kimliği ve ileti kimliği içerir.
  • Yeni metinle ayarlanan text alanı.
• updateMask değerini text değeriyle iletin.

Güncellenen mesaj bir kart mesajı ise metin, kartların başına eklenir (kartlar gösterilmeye devam eder).

Kullanıcı kimlik doğrulamasıyla bir mesajı güncelleme veya kart mesajına kısa mesaj ekleme işlemini aşağıda bulabilirsiniz:

Node.js

chat/client-libraries/cloud/update-message-user-cred.js

GitHub'da göster

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages'];

// This sample shows how to update a message with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Updated with user credential!'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_user_cred.py

GitHub'da göster

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.messages"]

# This sample shows how to update a message with user credential
def update_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Updated with user credential!"
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageUserCred.java

GitHub'da göster

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with user credential.
public class UpdateMessageUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Updated with user credential!"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("text"));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Komut Dosyası

chat/advanced-service/Main.gs

GitHub'da göster

/**
 * This sample shows how to update a message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages'
 * referenced in the manifest file (appsscript.json).
 */
function updateMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Updated with user credential!'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  });

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

Bu örneği çalıştırmak için aşağıdakileri değiştirin:

• SPACE_NAME: Alanın name kimliği. Kimliği, ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.
• MESSAGE_NAME: İletinin name kimliği. Kimliği, Chat API ile mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya mesaj oluşturulurken atanmış özel addan alabilirsiniz.

Chat API, güncellenen mesajla ilgili ayrıntıları içeren bir Message örneği döndürür.

Chat uygulaması olarak bir mesajı güncelleme

Uygulama kimlik doğrulaması ile bir mesajın hem metni hem de kartları güncellenebilir.

Bir mesajı uygulama kimlik doğrulamasıyla güncellemek için isteğinizde aşağıdakileri iletin:

• chat.bot yetkilendirme kapsamını belirtin.
• UpdateMessage() yöntemini çağırın.
• message değerini, aşağıdakilerle birlikte Message örneği olarak iletin:
  • Güncellenecek iletiye ayarlanan name alanı. Alan kimliği ve ileti kimliği içerir.
  • Güncellenmesi gerekiyorsa yeni metinle ayarlanan text alanı.
  • Güncellenmeleri gerekiyorsa yeni kartlarla ayarlanan cardsV2 alanı.
• updateMask'ü, text ve cardsV2 gibi güncellemelere alan listesini ekleyerek iletin.

Güncellenen mesaj bir kart mesajı ise ve metin güncellenirse güncellenen metin, kartların başına eklenir (kartlar gösterilmeye devam eder). Güncellenen mesaj bir mesaj ise ve kartlar güncellenirse güncellenen kartlar metne eklenir (gösterilmeye devam eder).

Uygulama kimlik doğrulamasıyla bir iletideki metni ve kartları nasıl güncelleyeceğiniz aşağıda açıklanmıştır:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js

GitHub'da göster

import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to update a message with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Text updated with app credential!',
      cardsV2 : [{ card: { header: {
        title: 'Card updated with app credential!',
        imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
      }}}]
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text', 'cards_v2']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_app_cred.py

GitHub'da göster

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to update a message with app credential
def update_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Text updated with app credential!",
            "cards_v2" : [{ "card": { "header": {
                "title": 'Card updated with app credential!',
                "image_url": 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
            }}}]
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text,cardsV2"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageAppCred.java

GitHub'da göster

import com.google.apps.card.v1.Card;
import com.google.apps.card.v1.Card.CardHeader;
import com.google.chat.v1.CardWithId;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with app credential.
public class UpdateMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Text updated with app credential!")
          .addCardsV2(CardWithId.newBuilder().setCard(Card.newBuilder()
            .setHeader(CardHeader.newBuilder()
              .setTitle("Card updated with app credential!")
              .setImageUrl("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg")))))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addAllPaths(List.of("text", "cards_v2")));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Komut Dosyası

chat/advanced-service/Main.gs

GitHub'da göster

/**
 * This sample shows how to update a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function updateMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Text updated with app credential!',
    cardsV2 : [{ card: { header: {
      title: 'Card updated with app credential!',
      imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
    }}}]
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text,cardsV2';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  }, getHeaderWithAppCredentials());

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

Bu örneği çalıştırmak için aşağıdakileri değiştirin:

• SPACE_NAME: Alanın name kimliği. Kimliği, ListSpaces() yöntemini çağırarak veya alanın URL'sinden alabilirsiniz.
• MESSAGE_NAME: İletinin name kimliği. Kimliği, Chat API ile mesaj oluşturduktan sonra döndürülen yanıt gövdesinden veya mesaj oluşturulurken atanmış özel addan alabilirsiniz.

Chat API, güncellenen mesajla ilgili ayrıntıları içeren bir Message örneği döndürür.

İlgili konular

• Mesaj biçimlendirme
• Bir iletiyi silme.
• Bir mesajla ilgili ayrıntıları öğrenme
• Alandaki mesajları listeleyebilirsiniz.
• Mesaj gönderin.