Para continuar, asegúrate de que completaste los pasos que se indican en Requisitos previos y de que aprobamos tu proyecto para el acceso a las APIs del Perfil de Negocio.
Habilita las APIs
Existen ocho APIs asociadas con el Perfil de Negocio que deben habilitarse en la Consola de APIs de Google:
- API de Google My Business
- API de My Business Account Management
- API de My Business Lodging
- API de My Business Place Actions
- API de My Business Notifications
- API de My Business Verifications
- API de Business Information para Mi Negocio
- API de preguntas y respuestas de Mi Negocio
Habilita una API
Si ya completaste todos los requisitos y se te otorgó acceso a la API, pero aún no puedes usar el acceso directo proporcionado, puedes habilitarla manualmente con los siguientes pasos.
Si deseas habilitar una API para tu proyecto, haz lo siguiente:
- Abre la Biblioteca de API en la Consola de APIs de Google. Si se te solicita, selecciona un proyecto o crea uno nuevo. La biblioteca de API enumera todas las APIs disponibles, agrupadas por familia de productos y popularidad.
- Si la API que quieres habilitar no está en la lista, usa la búsqueda para encontrarla.
- Selecciona la API que deseas habilitar y haz clic en el botón Habilitar.
- Si se te solicita, habilita la facturación.
- Si se te solicita, acepta las Condiciones del Servicio de la API.
Si eres usuario de Google Workspace, confirma que el Perfil de Negocio de Google esté activado para tu cuenta en tu organización de Google Workspace. Recibirás el "error 403: PERMISSION DENIED" cuando uses las APIs de GBP si el Perfil de Negocio de Google está desactivado para tu cuenta en tu organización de Google Workspace.
Cómo solicitar un ID de cliente de OAuth 2.0
Debido a que la app accede a datos protegidos y no públicos, necesitas un ID de cliente de OAuth 2.0. Esto permite que tu app solicite autorización para acceder a los datos de ubicación de tu organización en nombre de los usuarios de tu app.
Tu aplicación debe enviar un token de OAuth 2.0 con cualquier solicitud a las APIs del Perfil de Negocio que acceda a datos privados del usuario.
Si aún no lo hiciste, ve a la sección "Credenciales" de la Consola de API de Google y haz clic en Crear credenciales > ID de cliente de OAuth para crear tus credenciales de OAuth 2.0. Una vez que hayas creado las credenciales, podrás ver tu ID de cliente en la página Credenciales. Haz clic en el ID de cliente para obtener detalles, como el secreto de cliente, los URI de redireccionamiento, la dirección de origen de JavaScript y la dirección de correo electrónico.
Obtén información sobre los aspectos básicos de REST
Existen dos maneras de invocar las APIs:
- Envía una solicitud HTTP y analiza las respuestas.
- Usa bibliotecas cliente.
Si decides no usar bibliotecas cliente, debes comprender los conceptos básicos de REST.
REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.
El término REST es el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las APIs de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de datos almacenados por Google.
Un sistema RESTful almacena recursos en un almacén de datos. Un cliente envía una solicitud para que el servidor realice una acción en particular, como crear, recuperar, actualizar o borrar un recurso, y el servidor realiza la acción y envía una respuesta. Esa respuesta suele tener la forma de una representación del recurso especificado.
En las APIs de RESTful de Google, el cliente especifica una acción con un verbo HTTP, como GET, POST, PUT o DELETE. El cliente especifica un recurso mediante un identificador uniforme de recursos (URI) único a nivel global con la siguiente forma:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Debido a que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento en caché de datos y está optimizado para funcionar con la infraestructura distribuida de la Web.
Puedes encontrar las definiciones de los métodos en la documentación de estándares HTTP 1.1. Incluyen especificaciones para GET, POST, PUT y DELETE.
REST en las APIs del Perfil de Negocio
Las operaciones de las APIs del Perfil de Negocio se asignan directamente a los verbos HTTP de REST.
El formato específico de las APIs del Perfil de Negocio se muestra en el siguiente URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
El conjunto completo de los URI que se usan para cada operación compatible en las APIs aparece en la documentación de referencia de las APIs del Perfil de Negocio.
Las rutas de acceso de los recursos varían según el extremo.
Por ejemplo, la ruta de acceso del recurso a una cuenta aparece como en el siguiente ejemplo:
accounts/accountId
La ruta de acceso al recurso para una ubicación se muestra con el siguiente formato:
locations/locationId
Obtén información sobre los aspectos básicos de JSON
Las APIs del Perfil de Negocio muestran datos en formato JSON.
La notación de objetos de JavaScript (JSON) es un formato de datos común e independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.
Realiza una solicitud HTTP simple
Puedes usar OAuth 2.0 Playground para experimentar con las API del Perfil de Negocio. Debido a que las APIs del Perfil de Negocio no son APIs públicas, debes seguir algunos pasos adicionales para usarlas en Playground. Necesitas un ID de cliente para que una aplicación web continúe.
- Ve a la Consola de API de Google y abre tu proyecto. Si no tienes un ID de cliente de OAuth para aplicaciones web, crea uno ahora:
- En la lista desplegable Crear credenciales, selecciona ID de cliente de OAuth.
- En Tipo de aplicación, haz clic en Aplicación web.
Agrega lo siguiente como un URI de redireccionamiento válido:
https://developers.google.com/oauthplayground
- Haz clic en Crear.
- Copia el ID de cliente en el portapapeles.
- Ve a OAuth 2.0 Playground.
- Haz clic en el ícono de ajustes para abrir las opciones de configuración y realizar los siguientes cambios:
- Establece el flujo de OAuth en Del cliente.
- Selecciona Use your own OAuth credentials (Usa tus propias credenciales de OAuth).
- Pega tu ID de cliente de OAuth.
- Cierra las opciones de configuración.
En "Paso 1: Selecciona y autoriza las APIs", pega el siguiente alcance para las APIs del Perfil de Negocio en el campo Ingresa tus propios permisos:
https://www.googleapis.com/auth/business.manage
- Haz clic en Autorizar API.
- Haz clic en Aceptar cuando se te solicite.
-
En "Paso 2: Configurar solicitud a la API", pega el siguiente URI en el campo URI de solicitud:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Haz clic en Enviar solicitud. La respuesta debe mostrar un estado de
200 OK.
Si deseas obtener más información para realizar varios tipos de solicitudes, consulta la referencia de las APIs del Perfil de Negocio.
Bibliotecas cliente
Las bibliotecas cliente de las APIs del Perfil de Negocio admiten la funcionalidad de las APIs del Perfil de Negocio. Proporcionan funciones comunes a todas las APIs de Google, como el transporte HTTP, el manejo de errores, la autenticación y el análisis de JSON.
Para descargar bibliotecas cliente, consulta Bibliotecas.