Para continuar, asegúrate de haber completado los pasos que se indican en Requisitos previos y de que hayamos aprobado tu proyecto para el acceso a las APIs del Perfil de Negocio.
Habilitación de las API
Hay ocho APIs asociadas con el Perfil de Negocio que se deben habilitar 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 Q&A de Mi Negocio
Habilitar una API
Si completaste todos los Requisitos previos y se te otorgó acceso a la API, pero aún no puedes usar el atajo proporcionado, puedes habilitar la API de forma manual con los siguientes pasos.
Si deseas habilitar una API para tu proyecto, haz lo siguiente:
- Abre la Biblioteca de APIs en la Consola de APIs de Google. Si se te solicita, selecciona un proyecto o crea uno nuevo. La Biblioteca de API muestra 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, luego, 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 en 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.
Solicita un ID de cliente de OAuth 2.0
Como tu 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 de 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 la API de Google y haz clic en Crear credenciales > ID de cliente de OAuth para crear tus credenciales de OAuth 2.0. Después de crear 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 del cliente, los URIs 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, deberás 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 la sigla en inglés de "Representational State Transfer". En el contexto de las APIs de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena 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 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 de recursos uniforme (URI) único a nivel global del siguiente formato:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Dado que todos los recursos de API tienen URIs únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.
Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1. Incluyen especificaciones para GET, POST, PUT y DELETE.
REST en las APIs de Perfil de Negocio
Las operaciones de las APIs de Perfil de Negocio se asignan directamente a los verbos HTTP de REST.
El formato específico de las APIs de Perfil de Negocio se muestra en el siguiente URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
El conjunto completo de URIs que se usan para cada operación compatible en las APIs aparece en la documentación de referencia de las APIs de Perfil de Negocio.
Las rutas de acceso a los recursos varían según el extremo.
Por ejemplo, la ruta de acceso al recurso de una cuenta aparece como en el siguiente ejemplo:
accounts/accountId
La ruta de recursos de una ubicación aparece de la siguiente forma:
locations/locationId
Obtén información sobre los aspectos básicos de JSON
Las APIs de 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, consulta json.org.
Usa Oauth Playground para realizar una solicitud HTTP simple
Puedes usar OAuth 2.0 Playground para experimentar con las APIs de Perfil de Negocio. Debido a que las APIs de Perfil de Negocio no son 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 realiza los siguientes cambios:
- Establece Flujo de OAuth en Cliente.
- Selecciona Usar 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 permiso para las APIs de 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: Configura la solicitud a la API", pega el siguiente URI en el campo Request URI:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Haz clic en Enviar la solicitud. La respuesta debe mostrar un estado
200 OK.
Para obtener más información sobre cómo realizar varios tipos de solicitudes, consulta la Referencia de las APIs de Perfil de Negocio.
Bibliotecas cliente
Las bibliotecas cliente de las APIs de Perfil de Negocio admiten la funcionalidad de las APIs de Perfil de Negocio. Proporcionan una funcionalidad común 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.