Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Este documento explica como começar a desenvolver com a API Nearby Messages no
iOS.
Etapa 1: obter a versão mais recente do Xcode
Para criar um projeto usando a API Google Nearby Messages para iOS, você precisa da
versão 6.3 ou mais recente do Xcode.
Etapa 2: instalar o CocoaPods
A API Google Nearby Messages para iOS está disponível como um pod do CocoaPods. O CocoaPods é um gerenciador de dependências de código aberto para projetos Cocoa em Swift e Objective-C.
Se você ainda não tem essa ferramenta, instale-a no OS X executando o
comando abaixo no terminal. Para saber mais, consulte o Guia de
primeiros passos do CocoaPods.
$sudogeminstallcocoapods
Etapa 3: instalar a API usando o CocoaPods
Crie um Podfile para a API Google Nearby Messages para iOS e use-o para
instalar a API e as dependências dela.
Se você ainda não tiver um projeto Xcode, crie um agora e salve-o na
máquina local. Se você não tem experiência com desenvolvimento para iOS, crie um aplicativo de visualização
única e verifique se a opção "Usar contagem automática de referências" está ativada.
Crie um arquivo chamado Podfile no seu diretório do projeto Esse arquivo define as
dependências do projeto.
Edite o Podfile e adicione suas dependências. Aqui está um Podspec simples,
incluindo o nome do pod necessário para a API Google Nearby Messages para
iOS:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '7.0'
pod 'NearbyMessages'
Salve o Podfile.
Abra um terminal e acesse o diretório que contém o Podfile:
$ cd
Execute o comando pod install. Isso vai instalar as APIs especificadas no
Podspec e as respectivas dependências.
$ pod install
Feche o Xcode e clique duas vezes no arquivo .xcworkspace do projeto
para iniciar o Xcode. Depois disso, é preciso usar o arquivo .xcworkspace para
abrir o projeto.
Etapa 4: criar um cabeçalho de ponte (somente Swift)
Se você criou o projeto usando Swift, adicione um cabeçalho de bridging ao
projeto para que ele possa usar as bibliotecas instaladas pelo arquivo pod.
Siga estas etapas para adicionar um cabeçalho de ponte:
No mesmo diretório do arquivo .xcworkspace do projeto, adicione um novo
arquivo de cabeçalho (nomeie como quiser e use a extensão de nome de arquivo ".h").
Cole o seguinte código no arquivo que você criou:
#import <GNSMessages.h>.
Salve o arquivo.
No painel esquerdo do editor de projeto, selecione o projeto principal.
Clique em Build Settings na parte de cima do editor de build.
Em Build Settings, navegue até "Swift Compiler - Code Generation". Digite
"Swift Compiler" na caixa de pesquisa para localizá-lo rapidamente.
Clique na seta para abrir a seção Objective-C Bridging Header.
Em Debug e Release, adicione o caminho para o arquivo de cabeçalho que você
criou.
Crie o projeto para que as mudanças entrem em vigor.
Etapa 5: ter uma Conta do Google
Para usar as APIs Nearby Messages, você precisa de uma Conta do Google.
Se você já tem uma conta, então está tudo pronto. Para fins de teste, utilize uma
Conta do Google separada.
Etapa 6: gerar uma chave de API
Siga estas etapas para ativar a API Google Nearby Messages para iOS e receber uma
chave de API:
Crie ou selecione um projeto para registrar seu aplicativo.
Clique em Continuar para ativar a API.
Na página Credenciais, crie uma nova chave do iOS e defina as credenciais da API.
Observação: se você tiver uma chave do iOS, use essa chave.
Na caixa de diálogo resultante, insira o identificador do pacote do seu app. Exemplo:
com.example.nearbyexample
A nova chave de API do iOS aparece na lista de chaves de API do projeto.
Uma chave de API é uma string de caracteres, similar a esta:
AIzaSyBdVl-cTICSwYKrZ95SuvNw7dbMuDt1KG0
Para evitar o roubo de cota, proteja sua chave de API seguindo estas
práticas recomendadas.
Etapa 7: criar um objeto de gerenciador de mensagens
O objeto do gerenciador de mensagens permite que você publique e se inscreva. A troca de mensagens não é
autenticada. Portanto, você precisa fornecer a chave de API criada na etapa
anterior.
[null,null,["Última atualização 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"]]
