API de Hello Analytics: Guía de inicio rápido de Java para cuentas de servicio

En este instructivo, se explican los pasos necesarios para acceder a una cuenta de Google Analytics, consultar las APIs de Analytics, manejar las respuestas de la API y generar los resultados. En este instructivo, se usan la API de Core Reporting v3.0, la API de Management v3.0 y OAuth2.0.

Nota: El propósito de estas guías de inicio rápido es ayudarte a superar los obstáculos iniciales de la autorización de API con las bibliotecas cliente de la API de Google. Como estas bibliotecas están en desarrollo activo, es posible que, en ocasiones, estas guías no estén sincronizadas con las bibliotecas cliente más recientes. Si te encuentras con este problema, deberías consultar la documentación de la biblioteca cliente y, si es necesario, consultar la documentación de ayuda.

Paso 1: Habilita la API de Analytics

Para comenzar a usar la API de Google Analytics, primero debes utilizar la herramienta de configuración, que te guiará para crear un proyecto en la Consola de APIs de Google, habilitar la API y crear credenciales.

Crea un ID de cliente

1. Abre la página Cuentas de servicio. Si se te solicita, selecciona un proyecto.
2. Haz clic en Crear cuenta de servicio y, luego, ingresa un nombre y una descripción para la cuenta de servicio. Puedes usar el ID predeterminado de la cuenta de servicio o elegir uno que sea único y diferente. Cuando hayas terminado, haz clic en Crear.
3. No es obligatoria la sección de Permisos de cuenta de servicio (opcional) que aparece a continuación. Haz clic en Continuar.
4. En la pantalla Otorga a usuarios acceso a esta cuenta de servicio, desplázate hacia abajo hasta encontrar la sección Crear clave. Haz clic en Crear clave.
5. En el panel lateral que aparece, selecciona el formato para tu clave. Se recomienda el código JSON.
6. Haz clic en Crear. Ya se generó y descargó el nuevo par de claves pública y privada en tu equipo, que será la única copia. Para obtener más información a fin de almacenarla de forma segura, consulta Cómo administrar claves para cuentas de servicio.
7. Haz clic en Cerrar, en el diálogo Se guardó la clave privada en tu computadora, y luego haz clic en Listo para regresar a la tabla de tus cuentas de servicio.

Cuando se te solicite el Tipo de clave, selecciona JSON y guarda la clave generada como client_secrets.json. La necesitarás más adelante en el instructivo.

Agregar una cuenta de servicio a una cuenta de Google Analytics

La cuenta de servicio recién creada tendrá una dirección de correo electrónico, <projectId>-<uniqueId>@developer.gserviceaccount.com. Usa esta dirección de correo electrónico para agregar un usuario a la cuenta de Google Analytics a la que deseas acceder a través de la API. Para este instructivo, solo se necesitan los permisos de lectura y análisis.

Paso 2: Instala la biblioteca cliente de Google

Para instalar el cliente de Java de la API de Google Analytics, debes descargar un archivo ZIP que contenga todos los archivos jar que necesitas extraer y copiar en tu ruta de clase de Java.

1. Descarga la biblioteca cliente de Google Analytics para Java, que se incluye como un archivo ZIP con todas las dependencias necesarias.
2. Extraiga el archivo ZIP.
3. Agrega todos los archivos JAR del directorio libs a tu ruta de clase.
4. Agrega el jar google-api-services-analytics-v3-[version].jar a la ruta de clase.

Obtén más información sobre los detalles del entorno de Java.

Detalles del entorno de Java

Si usas Eclipse, consulta aquí las instrucciones para agregar archivos JAR a la ruta de clase de tu proyecto.

Si usas NetBeans, consulta aquí las instrucciones para agregar archivos JAR a la ruta de clase de tu proyecto.

Si usas IntelliJ IDEA, consulta aquí las instrucciones para agregar archivos JAR a la ruta de clase de tu proyecto.

Si desarrollas desde la línea de comandos, agrega -classpath /path/to/directory/with/unzipped/jars a tus invocaciones de comandos javac y java.

Nota: Según tu entorno de ejecución de Java, es posible que también debas descargar y agregar el javax.servlet.jar a la ruta de clase del proyecto.

Paso 3: Configura la muestra

Deberás crear un solo archivo llamado HelloAnalytics.java, que contendrá el código de muestra proporcionado.

1. Copia o descarga el siguiente código fuente en HelloAnalytics.java.
2. Mueve el client_secrets.JSON descargado previamente dentro del mismo directorio que el código de muestra.
3. Reemplaza los valores de KEY_FILE_LOCATION por los valores adecuados de Play Console.

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;

import com.google.api.services.analytics.Analytics;
import com.google.api.services.analytics.AnalyticsScopes;
import com.google.api.services.analytics.model.Accounts;
import com.google.api.services.analytics.model.GaData;
import com.google.api.services.analytics.model.Profiles;
import com.google.api.services.analytics.model.Webproperties;

import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.io.IOException;


/**
 * A simple example of how to access the Google Analytics API using a service
 * account.
 */
public class HelloAnalytics {


  private static final String APPLICATION_NAME = "Hello Analytics";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  public static void main(String[] args) {
    try {
      Analytics analytics = initializeAnalytics();

      String profile = getFirstProfileId(analytics);
      System.out.println("First Profile Id: "+ profile);
      printResults(getResults(analytics, profile));
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * Initializes an Analytics service object.
   *
   * @return An authorized Analytics service object.
   * @throws IOException
   * @throws GeneralSecurityException
   */
  private static AnalyticsReporting initializeAnalytic() throws GeneralSecurityException, IOException {

    HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
    GoogleCredential credential = GoogleCredential
        .fromStream(new FileInputStream(KEY_FILE_LOCATION))
        .createScoped(AnalyticsScopes.all());

    // Construct the Analytics service object.
    return new Analytics.Builder(httpTransport, JSON_FACTORY, credential)
        .setApplicationName(APPLICATION_NAME).build();
  }


  private static String getFirstProfileId(Analytics analytics) throws IOException {
    // Get the first view (profile) ID for the authorized user.
    String profileId = null;

    // Query for the list of all accounts associated with the service account.
    Accounts accounts = analytics.management().accounts().list().execute();

    if (accounts.getItems().isEmpty()) {
      System.err.println("No accounts found");
    } else {
      String firstAccountId = accounts.getItems().get(0).getId();

      // Query for the list of properties associated with the first account.
      Webproperties properties = analytics.management().webproperties()
          .list(firstAccountId).execute();

      if (properties.getItems().isEmpty()) {
        System.err.println("No Webproperties found");
      } else {
        String firstWebpropertyId = properties.getItems().get(0).getId();

        // Query for the list views (profiles) associated with the property.
        Profiles profiles = analytics.management().profiles()
            .list(firstAccountId, firstWebpropertyId).execute();

        if (profiles.getItems().isEmpty()) {
          System.err.println("No views (profiles) found");
        } else {
          // Return the first (view) profile associated with the property.
          profileId = profiles.getItems().get(0).getId();
        }
      }
    }
    return profileId;
  }

  private static GaData getResults(Analytics analytics, String profileId) throws IOException {
    // Query the Core Reporting API for the number of sessions
    // in the past seven days.
    return analytics.data().ga()
        .get("ga:" + profileId, "7daysAgo", "today", "ga:sessions")
        .execute();
  }

  private static void printResults(GaData results) {
    // Parse the response from the Core Reporting API for
    // the profile name and number of sessions.
    if (results != null && !results.getRows().isEmpty()) {
      System.out.println("View (Profile) Name: "
        + results.getProfileInfo().getProfileName());
      System.out.println("Total Sessions: " + results.getRows().get(0).get(0));
    } else {
      System.out.println("No results found");
    }
  }
}

Paso 4: Ejecuta la muestra

Después de habilitar la API de Analytics, instala la biblioteca cliente de las APIs de Google para Java y configura el código fuente de muestra que la muestra está lista para ejecutarse.

Si usas un IDE, asegúrate de tener un objetivo de ejecución predeterminado establecido en la clase HelloAnalytics. De lo contrario, puedes compilar y ejecutar la aplicación desde la línea de comandos:

1. Compila la muestra con el comando

   javac -classpath /path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics.java

   .
2. Ejecuta la muestra con el comando

   java -classpath ./:/path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics

   .

Cuando termines estos pasos, la muestra mostrará el nombre de la primera vista (perfil) de Google Analytics del usuario autorizado y la cantidad de sesiones de los últimos siete días.

Nota: Para ejecutar correctamente este ejemplo, deberás tener al menos una propiedad y una vista (perfil) de Google Analytics.

Con el objeto de servicio autorizado de Analytics, ahora puedes ejecutar cualquiera de las muestras de código que se encuentran en los documentos de referencia de la API de Management. Por ejemplo, podrías intentar cambiar el código para usar el método accountSummaries.list.