Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ce document explique comment commencer à développer avec l'API Nearby Messages sur iOS.
Étape 1 : Obtenir la dernière version de Xcode
Pour créer un projet à l'aide de l'API Google Nearby Messages pour iOS, vous avez besoin de la version 6.3 ou ultérieure de Xcode.
Étape 2: Obtenir CocoaPods
L'API Google Nearby Messages pour iOS est disponible en tant que pod CocoaPods. CocoaPods est un gestionnaire de dépendances Open Source pour les projets Cocoa Swift et Objective-C.
Si vous ne possédez pas encore l'outil CocoaPods, installez-le sur OS X en exécutant la commande ci-dessous à partir du terminal. Pour en savoir plus, consultez le guide de démarrage de CocoaPods.
$sudogeminstallcocoapods
Étape 3: Installer l'API à l'aide de CocoaPods
Créez un Podfile pour l'API Google Nearby Messages pour iOS, et utilisez-le pour installer l'API et ses dépendances.
Si vous n'avez pas encore de projet Xcode, créez-en un et enregistrez-le sur votre machine locale. (Si vous débutez avec le développement iOS, créez une application Single View et assurez-vous que l'option "Use Automatic Reference Counting" (Utiliser le comptage automatique des références) est activée.)
Créez un fichier nommé Podfile dans le répertoire de votre projet. Ce fichier définit les dépendances de votre projet.
Modifiez le Podfile et ajoutez vos dépendances. Voici un Podspec simple, y compris le nom du pod dont vous avez besoin pour l'API Google Nearby Messages pour iOS:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '7.0'
pod 'NearbyMessages'
Enregistrez le Podfile.
Ouvrez un terminal et accédez au répertoire contenant le Podfile:
$ cd
Exécutez la commande pod install. Cela installera les API spécifiées dans le Podspec, ainsi que toutes les éventuelles dépendances.
$ pod install
Fermez Xcode, puis ouvrez (double-cliquez) le fichier .xcworkspace de votre projet pour lancer Xcode. À partir de ce moment, vous devez utiliser le fichier .xcworkspace pour ouvrir le projet.
Étape 4: Créez un en-tête de pontage (Swift uniquement)
Si vous avez créé votre projet à l'aide de Swift, vous devez ajouter un en-tête de pontage à votre projet afin qu'il puisse utiliser les bibliothèques installées par le fichier pod.
Pour ajouter un en-tête de pontage, procédez comme suit:
Dans le même répertoire que le fichier .xcworkspace de votre projet, ajoutez un fichier d'en-tête (nommez-le comme vous le souhaitez et utilisez une extension de nom de fichier ".h").
Collez le code suivant dans le fichier que vous avez créé :
#import <GNSMessages.h>.
Enregistrez le fichier.
Dans le volet de gauche de l'éditeur de projet, sélectionnez le projet principal.
Cliquez sur Build Settings (Paramètres de compilation) en haut de l'éditeur de compilation.
Dans les paramètres de compilation, accédez à "Swift Compiler - Code Generation" (Compilateur Swift – Génération de code) (saisissez "Swift Compiler" dans le champ de recherche pour le trouver rapidement).
Cliquez sur la flèche pour développer la section En-tête de pontage Objective-C.
Sous Debug (Débogage) et Release (Version), ajoutez le chemin d'accès au fichier d'en-tête que vous avez créé.
Compilez le projet pour que les modifications prennent effet.
Étape 5: Obtenez un compte Google
Pour utiliser les API Nearby Messages, vous avez besoin d'un compte Google.
Si vous avez déjà un compte, vous êtes prêt. Vous pouvez également créer un compte Google distinct à des fins de test.
Étape 6: Obtenez une clé API
Pour activer l'API Google Nearby Messages pour iOS et obtenir une clé API, procédez comme suit:
Créez ou sélectionnez un projet avec lequel enregistrer votre application.
Cliquez sur Continuer pour activer l'API.
Sur la page Identifiants, créez une clé iOS (et définissez les identifiants de l'API).
Remarque: Si vous disposez d'une clé iOS, vous pouvez l'utiliser.
Dans la boîte de dialogue qui s'affiche, saisissez l'identifiant du bundle de votre application. Exemple :
com.example.nearbyexample
Votre nouvelle clé API iOS s'affiche dans la liste des clés API de votre projet.
Une clé API est une chaîne de caractères semblable à ce qui suit :
AIzaSyBdVl-cTICSwYKrZ95SuvNw7dbMuDt1KG0
Pour éviter le vol de quotas, sécurisez votre clé API en suivant ces bonnes pratiques.
Étape 7: Créez un objet Gestionnaire de messages
L'objet Gestionnaire de messages vous permet de publier et de vous abonner. L'échange de messages n'est pas authentifié. Vous devez donc fournir la clé API que vous avez créée à l'étape précédente.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 2025/08/29 (UTC)."],[[["\u003cp\u003eThe Nearby Messages API is deprecated and will stop working in December 2023, with users encouraged to migrate to Nearby Connections.\u003c/p\u003e\n"],["\u003cp\u003eDeveloping with the Nearby Messages API on iOS requires Xcode version 6.3 or later and the use of CocoaPods for dependency management.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the API is done via creating and editing a \u003ccode\u003ePodfile\u003c/code\u003e with a simple \u003ccode\u003epod install\u003c/code\u003e command in the terminal.\u003c/p\u003e\n"],["\u003cp\u003eSwift projects additionally require the creation of a bridging header file, referencing GNSMessages.h, and specifying the path to this in the project's build settings.\u003c/p\u003e\n"],["\u003cp\u003eUsing the API requires a Google account and an API key, which is generated in the Google Developers Console by enabling the Nearby Messages API.\u003c/p\u003e\n"]]],["The guide outlines the process for developing with the deprecated Nearby Messages API on iOS. Key actions include: installing Xcode (v6.3+), setting up CocoaPods for dependency management, creating a `Podfile` to install the 'NearbyMessages' pod, and adding a bridging header for Swift projects. A Google account and an iOS API key are needed, generated via the Google Developers Console using the app's bundle identifier. Finally, a message manager object is created using the API key to enable publishing and subscribing.\n"],null,["# Get Started\n\n| **Warning:** Nearby Messages is deprecated and will stop working as of December 2023. Please navigate to [Nearby Connections](//developers.google.com/nearby/connections/overview) for further support or [Migration Guideline](//developers.google.com/nearby/messages/ios/migrate-to-nc) on how to migrate existing Nearby Messages usage to Nearby Connections.\n\nThis document explains how to start developing with the Nearby Messages API on\niOS.\n\nStep 1: Get the latest version of Xcode\n---------------------------------------\n\nTo build a project using the Google Nearby Messages API for iOS, you need\n**version 6.3** or later of [Xcode](https://developer.apple.com/xcode/).\n\nStep 2: Get CocoaPods\n---------------------\n\nThe Google Nearby Messages API for iOS is available as a\n[CocoaPods](https://cocoapods.org/) pod. CocoaPods is an open source dependency\nmanager for Swift and Objective-C Cocoa projects.\n\nIf you don't already have the CocoaPods tool, install it on OS X by running the\nfollowing command from the terminal. For details, see the [CocoaPods Getting\nStarted guide](https://guides.cocoapods.org/using/getting-started.html). \n\n $ sudo gem install cocoapods\n\nStep 3: Install the API using CocoaPods\n---------------------------------------\n\nCreate a `Podfile` for the Google Nearby Messages API for iOS and use it to\ninstall the API and its dependencies.\n\n- If you don't have an Xcode project yet, create one now and save it to your local machine. (If you're new to iOS development, create a Single View Application, and ensure that Use Automatic Reference Counting is turned on.)\n- Create a file named `Podfile` in your project directory. This file defines your project's dependencies.\n- Edit the `Podfile` and add your dependencies. Here is a simple Podspec,\n including the name of the pod you need for the Google Nearby Messages API for\n iOS:\n\n ```text\n source 'https://github.com/CocoaPods/Specs.git'\n platform :ios, '7.0'\n pod 'NearbyMessages'\n ```\n\n \u003cbr /\u003e\n\n- Save the `Podfile`.\n\n- Open a terminal and go to the directory containing the `Podfile`:\n\n $ cd\n- Run the `pod install` command. This will install the APIs specified in the\n Podspec, along with any dependencies they may have.\n\n $ pod install\n- Close Xcode, and then open (double-click) your project's `.xcworkspace` file\n to launch Xcode. From this time onwards, you must use the `.xcworkspace` file to\n open the project.\n\nStep 4: Create a bridging header (Swift only)\n---------------------------------------------\n\nIf you created your project using Swift, you must add a bridging header to your\nproject so that it can use the libraries that were installed by the pod file.\nTake these steps to add a bridging header:\n\n1. In the same directory as your project's `.xcworkspace` file, add a new header file (name it whatever you like and use a filename extension of \".h\").\n2. Paste the following code into the file you created: `#import \u003cGNSMessages.h\u003e`.\n3. Save the file.\n4. In the project editor left pane, select the main project.\n5. Click **Build Settings** at the top of the build editor.\n6. In Build Settings, navigate to \"Swift Compiler - Code Generation\" (type \"Swift Compiler\" into the search box to locate it quickly).\n7. Click the arrow to expand the **Objective-C Bridging Header** section.\n8. Under **Debug** and **Release**, add the path to the header file you created.\n9. Build the project to make the changes take effect.\n\nStep 5: Get a Google account\n----------------------------\n\nTo use the Nearby Messages APIs, you need a [Google Account](//www.google.com/accounts/NewAccount).\nIf you already have an account, then you're all set. You may also want a\nseparate Google Account for testing purposes.\n\nStep 6: Get an API key\n----------------------\n\nTake these steps to enable the Google Nearby Messages API for iOS and get an\nAPI key:\n\n1. Go to the [Google Developers Console](https://console.developers.google.com/flows/enableapi?apiid=copresence&keyType=CLIENT_SIDE_IOS&reusekey=true).\n2. Create or select a project to register your application with.\n3. Click **Continue** to Enable the API.\n4. On the **Credentials** page, create a new **iOS key** (and set the API Credentials). \n Note: If you have an existing **iOS key**, you may use that key.\n5. In the resulting dialog, enter your app's bundle identifier. For example: \n\n ```\n com.example.nearbyexample\n ```\n6. Your new iOS API key appears in the list of API keys for your project. An API key is a string of characters, something like this: \n\n ```\n AIzaSyBdVl-cTICSwYKrZ95SuvNw7dbMuDt1KG0\n ```\n7. To prevent quota theft, secure your API key following these [best practices](/console/help/console#apikeybestpractices).\n\n| **Note:** If you are also developing an Android app, or using the Proximity Beacon REST API, make sure you generate all respective API keys within the same Google Developers Console project. For more information, see the [Getting Started guide for Android](/nearby/messages/android/get-started), and [Get Started with the REST API](/beacons/proximity/get-started).\n\nStep 7: Create a message manager object\n---------------------------------------\n\nThe message manager object lets you publish and subscribe. Message exchange is\nunauthenticated, so you must supply the API key you created in the previous\nstep.\n\n\u003cbr /\u003e\n\n### Objective-C\n\n\u003cbr /\u003e\n\n #import \u003cGNSMessages.h\u003e\n\n GNSMessageManager *messageManager =\n [[GNSMessageManager alloc] initWithAPIKey:@\"API_KEY\"];\n\n\u003cbr /\u003e\n\n### Swift\n\n\u003cbr /\u003e\n\n let messageManager = GNSMessageManager(APIKey: \"API_KEY\")\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e"]]
