Google Cloud MessagingGoogle Cloud Messaging

Предупреждение

Нерекомендуемый GCM в Google с 10 апреля 2018 г.Google deprecated GCM as of April 10, 2018. Следующие документы и образцы проектов могут больше не поддерживаться.The following docs and sample projects may no longer be maintained. API сервера и клиента GCM Google будут удалены сразу после 29 мая 2019.Google's GCM server and client APIs will be removed as soon as May 29, 2019. Google рекомендует перенести приложения GCM в Firebase Cloud Messaging (FCM).Google recommends migrating GCM apps to Firebase Cloud Messaging (FCM). Дополнительные сведения об устаревании и миграции GCM см. в статье нерекомендуемый облачный обмен сообщениями в Google.For more information about GCM deprecation and migration, see Google Deprecated Cloud Messaging.

Чтобы приступить к использованию облачной службы обмена сообщениями Firebase с Xamarin, см. статью Firebase Cloud Messaging.To start using Firebase Cloud Messaging with Xamarin, see Firebase Cloud Messaging.

Google Cloud Messaging (GCM) — это служба, которая упрощает обмен сообщениями между мобильными приложениями и серверных приложений. В этой статье приводятся общие сведения о работе GCM и объясняется, как настроить службы Google, чтобы приложение могла использовать GCM.Google Cloud Messaging (GCM) is a service that facilitates messaging between mobile apps and server applications. This article provides an overview of how GCM works, and it explains how to configure Google Services so your app can use GCM.

Эмблема Google Cloud MessagingGoogle Cloud Messaging logo

В этом разделе представлен общий обзор того, как Google Cloud Messaging маршрутизирует сообщения между приложением и сервером приложений и предоставляет пошаговую процедуру для получения учетных данных, чтобы приложение может использовать службы GCM.This topic provides a high-level overview of how Google Cloud Messaging routes messages between your app and an app server, and it provides a step-by-step procedure for acquiring credentials so that your app can use GCM services.

ОбзорOverview

Google Cloud Messaging (GCM) — это служба, которая обрабатывает отправку, маршрутизацию и очередь сообщений между серверными приложениями и мобильными клиентскими приложениями.Google Cloud Messaging (GCM) is a service that handles the sending, routing, and queueing of messages between server applications and mobile client apps. Клиентское приложение — это приложение с поддержкой GCM, которое выполняется на устройстве.A client app is a GCM-enabled app that runs on a device. Сервер приложений (предоставленный вами или вашей организацией) — это сервер с поддержкой GCM, с которым клиентское приложение взаимодействует через gcm:The app server (provided by you or your company) is the GCM-enabled server that your client app communicates with through GCM:

GCM находится между клиентским приложением и сервером приложенийGCM resides between the client app and the app server

С помощью GCM серверы приложений могут отсылать сообщения на одно устройство, группу устройств или на несколько устройств, подписанных на раздел.Using GCM, app servers can send messages to a single device, a group of devices, or a number of devices that are subscribed to a topic. Клиентское приложение может использовать GCM для подписки на подчиненные сообщения с сервера приложений (например, для получения удаленных уведомлений).Your client app can use GCM to subscribe to downstream messages from an app server (for example, to receive remote notifications). Кроме того, GCM позволяет клиентским приложениям передавать вышестоящее сообщение обратно на сервер приложений.Also, GCM makes it possible for client apps to send upstream messages back to the app server.

Сведения о реализации сервера приложений для GCM см. в разделе о сервере соединений gcm.For information about implementing an app server for GCM, see About GCM Connection Server.

Google Cloud Messaging в действииGoogle Cloud Messaging in Action

При отправке подчиненных сообщений с сервера приложений в клиентское приложение сервер приложений отправляет сообщение на сервер подключения gcm; сервер подключения GCM, в свою очередь, перенаправляет сообщение на устройство, на котором выполняется клиентское приложение.When downstream messages are sent from an app server to a client app, the app server sends the message to a GCM connection server; the GCM connection server, in turn, forwards the message to a device that is running your client app. Сообщения можно отправлять по протоколу HTTP или XMPP (расширенный протокол обмена сообщениями и протокола присутствия).Messages can be sent over HTTP or XMPP (Extensible Messaging and Presence Protocol). Поскольку клиентские приложения не всегда подключены или выполняются, сервер подключения GCM ставит в очередь и сохраняет сообщения, отправляя их в клиентские приложения при повторном подключении и доступности.Because client apps are not always connected or running, the GCM connection server enqueues and stores messages, sending them to client apps as they reconnect and become available. Аналогичным образом GCM помещает в очередь вышестоящее сообщение от клиентского приложения к серверу приложений, если сервер приложений недоступен.Similarly, GCM will enqueue upstream messages from the client app to the app server if the app server is unavailable.

GCM использует следующие учетные данные для указания сервера приложений и клиентского приложения и использует эти учетные данные для авторизации транзакций сообщений через GCM:GCM uses the following credentials to identify the app server and your client app, and it uses these credentials to authorize message transactions through GCM:

  • Ключ API Ключ API предоставляет серверу приложений доступ к службам Google. – GCM использует этот ключ для проверки подлинности сервера приложений.API Key – The API key gives your app server access to Google services; GCM uses this key to authenticate your app server. Перед использованием службы GCM необходимо сначала получить ключ API из консоли Google Developer , создав проект.Before you can use the GCM service, you must first obtain an API key from the Google Developer Console by creating a project. Ключ API должен обеспечивать безопасность; Дополнительные сведения о защите ключа API см. в статье рекомендации по безопасному использованию ключей API.The API Key should be kept secure; for more information about protecting your API key, see Best practices for securely using API keys.

  • Идентификатор отправителя Идентификатор отправителя разрешает серверу приложений клиентское приложение – . это уникальный номер, идентифицирующий сервер приложений, которому разрешено отправку сообщений в клиентское приложение. –Sender ID – The Sender ID authorizes the app server to your client app – it is a unique number that identifies the app server that is permitted to send messages to your client app. Идентификатор отправителя также является номером вашего проекта; При регистрации проекта вы получаете идентификатор отправителя из консоли разработчиков Google.The sender ID is also your project number; you obtain the sender ID from the Google Developers Console when you register your project.

  • Токен регистрации Маркер регистрации — это удостоверение gcm клиентского приложения на заданном устройстве. –Registration Token – The Registration Token is the GCM identity of your client app on a given device. Маркер регистрации создается во время – выполнения, когда приложение получает маркер регистрации при первой регистрации в gcm во время выполнения на устройстве.The registration token is generated at run time – your app receives a registration token when it first registers with GCM while running on a device. Маркер регистрации авторизует экземпляр клиентского приложения (выполняющегося на этом конкретном устройстве) для получения сообщений от GCM.The registration token authorizes an instance of your client app (running on that particular device) to receive messages from GCM.

  • Идентификатор приложения – Удостоверение клиентского приложения (независимо от любого конкретного устройства), которое регистрируется для получения сообщений от gcm.Application ID – The identity of your client app (independent of any given device) that registers to receive messages from GCM. В Android идентификатор приложения — это имя пакета, записанное в AndroidManifest. XML, например com.xamarin.gcmexample.On Android, the application ID is the package name recorded in AndroidManifest.xml, such as com.xamarin.gcmexample.

Настройка Google Cloud Messaging (далее в этом пошаговом окне) приведены подробные инструкции по созданию проекта и созданию этих учетных данных.Setting Up Google Cloud Messaging (later in this guide) provides detailed instructions for creating a project and generating these credentials.

В следующих разделах объясняется, как эти учетные данные используются при взаимодействии клиентских приложений с серверами приложений через GCM.The following sections explain how these credentials are used when client apps communicate with app servers through GCM.

Регистрация в GCMRegistration with GCM

Клиентское приложение, установленное на устройстве, должно сначала зарегистрироваться в GCM до того, как система обмена сообщениями может быть выполнена.A client app installed on a device must first register with GCM before messaging can take place. Клиентское приложение должно выполнить действия по регистрации, показанные на следующей схеме:The client app must complete the registration steps shown in the following diagram:

Шаги регистрации приложенияApp registration steps

  1. Клиентское приложение обращается к GCM, чтобы получить маркер регистрации, передав идентификатор отправителя в GCM.The client app contacts GCM to obtain a registration token, passing the sender ID to GCM.

  2. GCM возвращает маркер регистрации клиентскому приложению.GCM returns a registration token to the client app.

  3. Клиентское приложение перенаправляет маркер регистрации на сервер приложений.The client app forwards the registration token to the app server.

Сервер приложений кэширует маркер регистрации для последующего взаимодействия с клиентским приложением.The app server caches the registration token for subsequent communications with the client app. При необходимости сервер приложений может отправить подтверждение обратно в клиентское приложение, чтобы указать, что получен маркер регистрации.Optionally, the app server can send an acknowledgement back to the client app to indicate that the registration token was received. После выполнения этого подтверждения клиентское приложение может получать сообщения от сервера приложений (или отправлять сообщения на него).After this handshake takes place, the client app can receive messages from (or send messages to) the app server.

Когда клиентскому приложению больше не требуется получать сообщения с сервера приложений, оно может отправить запрос на сервер приложений для удаления маркера регистрации.When the client app no longer wants to receive messages from the app server, it can send a request to the app server to delete the registration token. Если клиентское приложение получает сообщения раздела (описанные далее в этой статье), оно может отказаться от подписки на раздел.If the client app is receiving topic messages (explained later in this article), it can unsubscribe from the topic. Если клиентское приложение удалено с устройства, GCM обнаруживает это и автоматически уведомляет сервер приложений об удалении маркера регистрации.If the client app is uninstalled from a device, GCM detects this and automatically notifies the app server to delete the registration token.

Регистрация клиентских приложений Google подробно объясняет процесс регистрации. Здесь объясняется, как отменить регистрацию и отменять подписку, а также описывается процесс отмены регистрации при удалении клиентского приложения.Google's Registering Client Apps explains the registration process in more detail; it explains unregistration and unsubscription, and it describes the process of unregistration when a client app is uninstalled.

Подчиненный обмен сообщениямиDownstream Messaging

Когда сервер приложений отправляет в клиентское приложение подчиненное сообщение, оно проходит шаги, показанные на следующей схеме:When the app server sends a downstream message to the client app, it follows the steps illustrated in the following diagram:

Хранилище подчиненных сообщений и схема пересылкиDownstream messaging store and forward diagram

  1. Сервер приложений отправляет сообщение в GCM.The app server sends the message to GCM.

  2. Если клиентское устройство недоступно, сервер GCM сохраняет сообщение в очереди для последующей передачи.If the client device is not available, the GCM server stores the message in a queue for later transmission.

  3. Когда клиентское устройство будет доступно, GCM отправляет это сообщение клиентскому приложению на этом устройстве.When the client device is available, GCM sends the message to the client app on that device.

  4. Клиентское приложение получает сообщение от GCM и соответствующим образом обрабатывает его.The client app receives the message from GCM and handles it accordingly. Например, если сообщение представляет собой удаленное уведомление, оно будет представлено пользователю.For example, if the message is a remote notification, it is presented to the user.

В этом сценарии обмена сообщениями (где сервер приложений отправляет сообщение в одно клиентское приложение) размер сообщений может доставлять до 4 КБ.In this messaging scenario (where the app server sends a message to a single client app), messages can be up to 4kB in length.

Подробные сведения (включая примеры кода) о получении подчиненных сообщений GCM в Android см. в разделе Удаленные уведомления.For detailed information (including code samples) about receiving downstream GCM messages on Android, see Remote Notifications.

Обмен сообщениями с темойTopic Messaging

Обмен сообщениями с темой — это тип подчиненного обмена сообщениями, в котором сервер приложений отправляет одно сообщение нескольким клиентским приложениям, которые подписываются на раздел (например, прогноз погоды).Topic Messaging is a type of downstream messaging where the app server sends a single message to multiple client app devices that subscribe to a topic (such as a weather forecast). Сообщения в разделе могут быть 2 КБ в длину, а сообщения раздела поддерживают до 1 000 000 подписок на приложение.Topic messages can be up to 2KB in length, and topic messaging supports up to one million subscriptions per app. Если GCM используется только для обмена сообщениями с разделами, клиентскому приложению не требуется передавать маркер регистрации на сервер приложений.If GCM is being used only for topic messaging, the client app is not required to send a registration token to the app server. В разделе сообщения , посвященном использованию Google, описывается отправка сообщений с сервера приложений на несколько устройств, подписанных на определенный раздел.Google's Implementing Topic Messaging explains how to send messages from an app server to multiple devices that subscribe to a particular topic.

Обмен сообщениями группыGroup Messaging

Обмен сообщениями групп — это тип подчиненного обмена сообщениями, в котором сервер приложений отправляет одно сообщение нескольким клиентским приложениям, принадлежащим к группе (например, группе устройств, принадлежащих одному пользователю).Group Messaging is a type of downstream messaging where the app server sends a single message to multiple client app devices that belong to a group (for example, a group of devices that belong to a single user). Размер сообщений группы может доставлять до 2 КБ для устройств iOS и до 4 КБ для устройств Android.Group messages can be up to 2KB in length for iOS devices, and up to 4KB in length for Android devices. Группа ограничена максимум 20 участниками.A group is limited to a maximum of 20 members. Обмен сообщениями в группе устройств Google объясняет, как серверы приложений могут отправить одно сообщение нескольким экземплярам клиентских приложений, выполняющимся на устройствах, принадлежащих группе.Google's Device Group Messaging explains how app servers can send a single message to multiple client app instances running on devices that belong to a group.

Потоковая передача сообщенийUpstream Messaging

Если клиентское приложение подключается к серверу, который поддерживает XMPP, он может отправить сообщения обратно на сервер приложений, как показано на следующей схеме:If your client app connects to a server that supports XMPP, it can send messages back to the app server as illustrated in the following diagram:

Диаграмма восходящего обмена сообщениямиUpstream messaging diagram

  1. Клиентское приложение отправляет сообщение на сервер подключения GCM XMPP.The client app sends a message to the GCM XMPP connection server.

  2. Если сервер приложений отключен, сервер GCM сохраняет сообщение в очереди для последующей пересылки.If the app server is disconnected, the GCM server stores the message in a queue for later forwarding.

  3. При повторном подключении сервера приложений GCM передает сообщение на сервер приложений.When the app server is re-connected, GCM forwards the message to the app server.

  4. Сервер приложений анализирует сообщение, чтобы проверить подлинность клиентского приложения, а затем отправляет "ACK" в GCM для подтверждения получения сообщения.The app server parses the message to verify the identity of the client app, then it sends an "ack" to GCM to acknowledge message receipt.

  5. Сервер приложений обрабатывает сообщение.The app server processes the message.

В вышестоящем сообщении Google объясняется, как структурировать сообщения в кодировке JSON и отправить их на серверы приложений, на которых выполняется облачный сервер подключения Google XMPP.Google's Upstream Messages explains how to structure JSON-encoded messages and send them to app servers that run Google's XMPP-based Cloud Connection Server.

Настройка Google Cloud MessagingSetting Up Google Cloud Messaging

Прежде чем вы сможете использовать службы GCM в своем приложении, сначала необходимо получить учетные данные для доступа к серверам GCM Google.Before you can use GCM services in your app, you must first acquire credentials for access to Google's GCM servers. В следующих разделах описаны шаги, необходимые для выполнения этого процесса.The following sections describe the steps required to complete this process:

Включение служб Google для приложенияEnable Google Services for Your App

  1. Войдите в консоль разработчиков Google с помощью учетной записи Google (например, адреса Gmail) и создайте новый проект.Sign into the Google Developers Console with your Google account (i.e, your gmail address) and create a new project. Если у вас уже есть проект, выберите проект, который требуется включить в GCM.If you have an existing project, choose the project that you want to become GCM-enabled. В следующем примере создается новый проект с именем ксамарингкм :In the following example, a new project called XamarinGCM is created:

    Создание проекта КсамарингкмCreating XamarinGCM project

  2. Затем введите имя пакета для своего приложения (в этом примере — имя пакета — com. Xamarin. гкмексампле) и нажмите кнопку продолжить, чтобы выбрать и настроить службы:Next, enter the package name for your app (in this example, the package name is com.xamarin.gcmexample) and click Continue to Choose and configure services:

    Ввод имени пакетаEntering the package name

    Обратите внимание, что это имя пакета также является ИДЕНТИФИКАТОРом приложения для приложения.Note that this package name is also the application ID for your app.

  3. В разделе Выбор и Настройка служб перечислены службы Google, которые можно добавить в приложение.The Choose and configure services section lists the Google services that you can add to your app. Щелкните облачная система обмена сообщениями.Click Cloud Messaging:

    Выбор облачных сообщенийChoose Cloud Messaging

  4. Затем щелкните включить Google Cloud MESSAGING.Next, click ENABLE GOOGLE CLOUD MESSAGING:

    Включить Google Cloud MessagingEnable Google Cloud Messaging

  5. Для приложения создаются ключ API сервера и идентификатор отправителя .A Server API key and a Sender ID are generated for your app. Запишите эти значения и нажмите кнопку Закрыть:Record these values and click CLOSE:

    Отображаемый ключ API сервера и идентификатор отправителяServer API Key and Sender ID displayed

    Защитите ключ – API, который он не предназначен для общедоступного использования.Protect the API key – it is not intended for public use. Если ключ API скомпрометирован, Неавторизованные серверы могут публиковать сообщения в клиентских приложениях.If the API key is compromised, unauthorized servers could publish messages to client applications. Рекомендации по безопасному использованию ключей API предоставляют полезные рекомендации по защите ключа API.Best practices for securely using API keys provides useful guidelines for protecting your API Key.

Просмотр параметров проектаView Your Project Settings

Вы можете просмотреть параметры проекта в любое время, войдя в консоль Google Cloud и выбрав свой проект.You can view your project settings at any time by signing into the Google Cloud Console and selecting your project. Например, можно просмотреть идентификатор отправителя , выбрав проект в раскрывающемся меню в верхней части страницы (в этом примере проект называется ксамарингкм).For example, you can view the Sender ID by selecting your project in the pull down menu at the top of the page (in this example, the project is called XamarinGCM). Идентификатор отправителя — это номер проекта, как показано на следующем снимке экрана (идентификатор отправителя — 9349932736):The Sender ID is the Project number as shown in this screenshot (the Sender ID here is 9349932736):

Просмотр идентификатора отправителяViewing the Sender ID

Чтобы просмотреть ключ API, щелкните Диспетчер API , а затем — учетные данные:To view the API key, click API Manager and then click Credentials:

Просмотр ключа APIViewing the API key

Дополнительные сведенияFor Further Reading

  • Регистрация клиентских приложений Google подробно описывает процесс регистрации клиентов и предоставляет сведения о настройке автоматической повторной попытки и синхронизации состояния регистрации.Google's Registering Client Apps describes the client registration process in more detail, and it provides information about configuring automatic retry and keeping the registration state in sync.

  • Rfc 6120 и RFC 6121 объясняют и определяют расширяемый протокол обмена сообщениями и присутствия (XMPP).RFC 6120 and RFC 6121 explain and define the Extensible Messaging and Presence Protocol (XMPP).

СводкаSummary

В этой статье представлен обзор Google Cloud Messaging (GCM).This article provided an overview of Google Cloud Messaging (GCM). В нем объясняются различные учетные данные, используемые для обнаружения и авторизации обмена сообщениями между серверами приложений и клиентскими приложениями.It explained the various credentials that are used to identify and authorize messaging between app servers and client apps. В нем проиллюстрированы наиболее распространенные сценарии обмена сообщениями и подробно описаны действия по регистрации приложения в GCM для использования служб GCM.It illustrated the most common messaging scenarios, and it detailed the steps for registering your app with GCM to use GCM services.