Antes de continuar, comprueba que has seguido todos los pasos que se indican en la página de requisitos previos y que hemos aprobado tu proyecto para que puedas acceder a las APIs de Perfil de Empresa.
Habilitar las APIs
Hay ocho APIs asociadas a Perfil de Empresa que se deben habilitar en la consola de APIs de Google:
- API de Google My Business
- API My Business Account Management
- API My Business Lodging
- API My Business Place Actions
- API My Business Notifications
- API My Business Verifications
- API Business Information de My Business
- API My Business Q&A
Habilitar una API
Si has cumplido todos los requisitos previos y te hemos dado acceso a la API, pero sigues sin poder usar el acceso directo proporcionado, sigue estos pasos para habilitar la API manualmente.
Para habilitar una API en tu proyecto, haz lo siguiente:
- Abre la biblioteca de APIs en la consola de APIs de Google. Si se te indica, selecciona un proyecto o crea uno. En la biblioteca de APIs se incluyen todas las APIs disponibles, agrupadas por familia de productos y popularidad.
- Si no consigues ver en la lista la API que quieres habilitar, usa la función de búsqueda para encontrarla.
- Selecciona la API que quieres habilitar y haz clic en el botón Habilitar.
- Si se te indica, habilita la facturación.
- Si se te indica, acepta los Términos del Servicio de la API.
Si usas Google Workspace, confirma que tu Perfil de Empresa en Google esté activado en tu organización de Google Workspace. Si usas las APIs de PEG y el Perfil de Empresa en Google está desactivado para tu cuenta en tu organización de Google Workspace, recibirás un error 403 de permiso denegado.
Solicitar un ID de cliente de OAuth 2.0
Como tu aplicación accede a datos protegidos que no son públicos, necesitas un ID de cliente de OAuth 2.0. Con este ID, tu aplicación puede solicitar autorización para acceder a los datos de ubicación de tu organización en nombre de los usuarios de tu aplicación.
Tu aplicación debe enviar un token de OAuth 2.0 con todas las solicitudes a las APIs de Perfil de Empresa que accedan a datos de usuario privados.
Si aún no lo has hecho, ve a la sección "Credenciales" de la consola de APIs 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 más información, como el secreto de cliente, los URIs de redirección, la dirección de origen de JavaScript y la dirección de correo electrónico.
Información básica sobre REST
Hay dos formas de invocar las APIs:
- Enviando una solicitud HTTP y analizando las respuestas.
- Usando bibliotecas de cliente.
Si decides no utilizar bibliotecas de cliente, debes comprender los conceptos básicos de REST.
REST es un estilo de arquitectura de software que permite solicitar y modificar datos de una forma práctica y coherente.
El término REST es la abreviatura en inglés de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las APIs de Google, hace referencia al uso de verbos HTTP para obtener y modificar representaciones de datos almacenados por Google.
En un sistema RESTful, los recursos se almacenan en un almacén de datos. Un cliente envía una solicitud para que el servidor realice una acción determinada, como crear, obtener, actualizar o eliminar un recurso, y el servidor realiza la acción y envía una respuesta. Esa respuesta suele ser 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 uniforme de recurso (URI) que es completamente único con el siguiente formato:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Como todos los recursos de la API tienen URIs únicos accesibles mediante HTTP, REST permite almacenar los datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.
Te recomendamos que consultes las definiciones de los métodos en la documentación de los estándares HTTP 1.1. Incluyen especificaciones para GET, POST, PUT y DELETE.
REST en las APIs de Perfil de Empresa
Las operaciones de las APIs de Perfil de Empresa están asociadas directamente a verbos HTTP de REST.
El formato específico de las APIs de Perfil de Empresa se muestra en el siguiente URI:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
El conjunto completo de URIs utilizados en cada operación que las APIs pueden realizar aparece en la documentación de referencia de las APIs de Perfil de Empresa.
Las rutas de los recursos varían en función del punto final.
Por ejemplo, la ruta del recurso a una cuenta se muestra como en el siguiente ejemplo:
accounts/accountId
La ruta del recurso de una ubicación se muestra con el siguiente formato:
locations/locationId
Información básica sobre JSON
Las APIs de Perfil de Empresa devuelven datos en formato JSON.
La notación de objetos JavaScript (JSON) es un formato de datos común e independiente del lenguaje que proporciona una representación de texto sencilla de estructuras de datos arbitrarias. Para obtener más información, accede a la página json.org.
Usar Oauth Playground para hacer una solicitud HTTP sencilla
Puedes utilizar OAuth 2.0 Playground para probar las APIs de Perfil de Empresa. Dado que las APIs de Perfil de Empresa no son APIs públicas, debes seguir estos pasos adicionales para utilizarlas en Playground. Necesitas un ID de cliente de una aplicación web para continuar.
- Ve a la consola de APIs de Google y abre el proyecto. Si no tienes un ID de cliente de OAuth para aplicaciones web, crea uno:
- En la lista desplegable Crear credenciales, selecciona ID de cliente de OAuth.
- En Tipo de aplicación, haz clic en Aplicación web.
Añade lo siguiente como URI de redirección válido:
https://developers.google.com/oauthplayground
- Haz clic en Crear.
- Copia el ID de cliente en el portapapeles.
- Accede a OAuth 2.0 Playground.
- Haz clic en el icono de la rueda dentada para abrir las opciones de configuración y hacer los siguientes cambios:
- Asigna el valor Client-side (En el cliente) a OAuth flow (Flujo de OAuth).
- Selecciona Use your own OAuth credentials (Utilizar tus propias credenciales de OAuth).
- Pega tu ID de cliente de OAuth.
- Cierra las opciones de configuración.
En la sección "Step 1 - Select & authorize APIs" (Paso 1: Seleccionar y autorizar APIs), pega en el campo Input your own scopes (Introduce tus propios permisos) el siguiente permiso para las APIs de Perfil de Empresa:
https://www.googleapis.com/auth/business.manage
- Haz clic en Authorize APIs (Autorizar APIs).
- Haz clic en Accept (Aceptar) cuando se te solicite.
-
En la sección "Step 2 - Configure request to API" (Paso 2: Configurar la solicitud a la API), pega el siguiente URI en el campo Request URI (URI de solicitud):
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Haz clic en Send the request (Enviar la solicitud). En la respuesta debería aparecer un estado
200 OK.
Para obtener más información sobre cómo hacer distintos tipos de solicitudes, consulta la referencia de las APIs de Perfil de Empresa.
Bibliotecas de cliente
Las bibliotecas de cliente de las APIs de Perfil de Empresa proporcionan las funciones de estas APIs. Ofrecen funciones comunes a todas las APIs de Google, como transporte HTTP, gestión de errores, autenticación y análisis de archivos JSON.
Para descargar bibliotecas de cliente, consulta la sección Bibliotecas.