Consejos para aumentar el rendimiento

En este documento se tratan algunas técnicas que puedes usar para mejorar el rendimiento de tu aplicación. En algunos casos, se usan ejemplos de otras API o API genéricas para ilustrar las ideas presentadas. Sin embargo, se pueden aplicar los mismos conceptos a la API de Google Analytics.

Usar gzip

Una forma sencilla y cómoda de reducir el ancho de banda necesario para cada solicitud consiste en habilitar la compresión gzip. Aunque esto requiere tiempo de CPU adicional para descomprimir los resultados, la compensación con los costes de red normalmente hace que merezca la pena.

Para recibir una respuesta con codificación gzip debes hacer dos cosas: establecer un encabezado Accept-Encoding y modificar su user-agent para que incluya la cadena gzip. A continuación, te mostramos un ejemplo de encabezados HTTP con formato correcto para habilitar la compresión gzip:

Accept-Encoding: gzip
User-Agent: my program (gzip)

Trabajar con recursos parciales

Otra forma de mejorar el rendimiento de las llamadas de API es solicitando solo la parte de los datos en los que estés interesado. De este modo tu aplicación no tendrá que transferir, analizar y almacenar campos innecesarios y podrá utilizar recursos como la red, la CPU y la memoria con más eficacia.

Respuesta parcial

De forma predeterminada, el servidor devuelve la representación completa de un recurso después de procesar las solicitudes. Para obtener un mejor rendimiento, puedes pedir al servidor que envíe únicamente los campos que realmente necesitas y obtener una respuesta parcial.

Para solicitar una respuesta parcial, usa el parámetro de solicitud fields a fin de especificar los campos que quieres que se devuelvan. Puedes usar este parámetro con cualquier solicitud que devuelva datos de respuesta.

Ejemplo

En el siguiente ejemplo se muestra el uso del parámetro fields con una API genérica de demostración (ficticia).

Solicitud simple: esta solicitud GET de HTTP omite el parámetro fields y devuelve el recurso completo.

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY

Respuesta del recurso completo: entre los datos del recurso completo se incluyen los siguientes campos, junto con muchos otros que se han omitido para abreviar.

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

Solicitud de una respuesta parcial: la solicitud siguiente para este mismo recurso utiliza el parámetro fields a fin de reducir considerablemente la cantidad de datos devueltos.

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY&fields=kind,items(title,characteristics/length)

Respuesta parcial: como respuesta a la solicitud anterior, el servidor devuelve una respuesta que incluye solo el tipo de información junto con una matriz reducida de elementos que contiene únicamente el título HTML y los datos sobre las características de la longitud de cada elemento.

200 OK

{
  "kind": "demo",
  "items": [
  {
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  },
  {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]

Ten en cuenta que la respuesta es un objeto JSON que incluye únicamente los campos seleccionados y sus objetos principales contenedores.

A continuación se ofrece información sobre cómo dar formato al parámetro fields, seguida de más datos sobre lo que se devuelve exactamente en la respuesta.

Resumen de la sintaxis del parámetro fields

El formato del valor del parámetro de solicitud fields se basa libremente en la sintaxis XPath. La sintaxis admitida se resume a continuación y se ofrecen ejemplos adicionales en la siguiente sección.

  • Utiliza una lista separada por comas para seleccionar varios campos.
  • Utiliza a/b para seleccionar un campo b anidado en el campo a; utiliza a/b/c para seleccionar un campo c anidado en b.

    Excepción: Para las respuestas de API que usen contenedores "data", donde la respuesta está anidada en un objeto data similar a data: { ... }, no incluyas "data" en la especificación fields. La inclusión del objeto data con una especificación fields como data/a/b provoca un error. En su lugar, utiliza solo una especificación fields como a/b.

  • Utiliza un selector secundario para solicitar un conjunto de campos secundarios específicos incluyendo las expresiones entre paréntesis "( )".

    Por ejemplo: fields=items(id,author/email) solo devuelve el ID del elemento y el correo electrónico del autor para cada elemento de la matriz. También puedes especificar un campo secundario individual, donde fields=items(id) equivale a fields=items/id.

  • Si es necesario, utiliza comodines en las selecciones de campo.

    Por ejemplo: fields=items/pagemap/* selecciona todos los objetos de un pagemap.

Más ejemplos del uso del parámetro fields

En los ejemplos siguientes se incluyen descripciones del modo en que el valor del parámetro fields afecta a la respuesta.

Nota: Al igual que sucede con todos los valores de parámetro de consulta, el valor de parámetro fields debe estar codificado para URL. Para facilitar la legibilidad, en los ejemplos de este documento se omite la codificación.

Identifica los campos que deseas que se devuelvan o realiza selecciones de campo.
El valor de parámetro de solicitud fields es una lista separada por comas de campos y cada campo se especifica relativo a la raíz de la respuesta. De este modo, si realizas una operación list, la respuesta es una colección y, por lo general, incluye una serie de recursos. Si vas realizar una operación que devuelve un solo recurso, los campos se especifican en relación con dicho recurso. Si el campo que seleccionas es una matriz, o parte de ella, el servidor devuelve la parte seleccionada de todos los elementos de la matriz.

A continuación, se ofrecen algunos ejemplos de colección:
Ejemplos Efecto
items Devuelve todos los elementos de la matriz, incluidos todos los campos de cada elemento, pero no el resto de campos.
etag,items Devuelve el campo etag y todos los elementos de la matriz items.
items/title Devuelve solo el campo title de todos los elementos de la matriz ítems.

Siempre que se devuelve un campo anidado, la respuesta incluye los objetos principales contenedores. Los campos principales no incluyen otros campos secundarios, salvo que también se hayan seleccionado de forma explícita.
context/facets/label Devuelve únicamente el campo label para todos los miembros de la matriz facets, que está anidada en el objeto context.
items/pagemap/*/title Por cada elemento de la matriz items, devuelve únicamente el campo title (si está) de todos los objetos secundarios de pagemap.

A continuación, se ofrecen algunos ejemplos de recurso:
Ejemplos Efecto
title Devuelve el campo title del recurso solicitado.
author/uri Devuelve el campo secundario uri del objeto author en el recurso solicitado.
links/*/href
Devuelve el campo href de todos los objetos que son secundarios de links.
Solicita solo partes de campos específicos mediante selecciones secundarias.
De forma predeterminada, si tu solicitud especifica determinados campos, el servidor devuelve los objetos o los elementos de matriz en su totalidad. Puedes especificar una respuesta que incluya únicamente determinados campos secundarios. Puedes hacerlo mediante la sintaxis de selección secundaria "( )", tal como se muestra en el ejemplo siguiente.
Ejemplo Efecto
items(title,author/uri) Devuelve únicamente los valores de title y uri del autor por cada elemento de la matriz items.

Cómo gestionar las respuestas parciales

Después de que un servidor procese una solicitud válida que incluya el parámetro de consulta fields, devuelve un código de estado HTTP 200 OK, junto con los datos solicitados. Si el parámetro de consulta fields tiene un error o no es válido, el servidor devuelve un código de estado HTTP 400 Bad Request, junto con un mensaje de error que indica al usuario el error de su selección de fields (por ejemplo, "Invalid field selection a/b").

A continuación, se muestra un ejemplo de respuesta parcial que aparece en la sección de introducción más arriba. En la solicitud se utiliza el parámetro fields para especificar los campos que deben devolverse.

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY&fields=kind,items(title,characteristics/length)

La respuesta parcial tiene el siguiente aspecto:

200 OK

{
  "kind": "demo",
  "items": [
  {
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  },
  {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]

Nota: Para las API que admiten parámetros de consulta para la paginación de datos (maxResults y nextPageToken, por ejemplo), utiliza estos parámetros para reducir los resultados de cada consulta y obtener así un tamaño que se pueda manejar. De lo contrario, podrían no obtenerse los beneficios de rendimiento que se conseguirían con la respuesta parcial.