Requisitos previos para la API de Indexing

Para poder comenzar a usar la API de Indexing, debes completar algunas acciones, si es que todavía no lo hiciste:

Crea un proyecto para tu cliente

Para poder enviar solicitudes a la API de Indexing, primero debes notificar a Google acerca de tu cliente y activar el acceso a la API. Puedes hacerlo con la Consola de API de Google si creas un proyecto (una colección determinada de configuraciones y datos de acceso a la API) y registras la aplicación.

Para comenzar a usar la API de Indexing, primero debes emplear la herramienta de configuración, que te guiará en el proceso de creación de un proyecto en Google API Console, la habilitación de la API y la creación de credenciales.

Crea una cuenta de servicio

  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.

Cómo agregar tu cuenta de servicio como propietario del sitio

Para agregar tu cuenta de servicio como propietario del sitio, haz lo siguiente:

  1. Primero, demuestra que eres el propietario del sitio con Search Console.
  2. Luego, agrega tu cuenta de servicio como propietario.

1. Demuestra que eres el propietario del sitio

Verifica la propiedad de tu sitio con Search Console. Puedes usar cualquier método de verificación que admita Search Console. Puedes crear una Propiedad de dominio (example.com) o una propiedad de prefijo de URL (https://example.com o https://example.com/alguna/ruta/) para representar tu sitio (ten en cuenta que los sitios se denominan propiedades en Search Console).

2. Otorga el estado de propietario a tu cuenta de servicio

Luego, sigue estos pasos para agregar tu cuenta de servicio como propietario (delegado) del sitio:

  1. Abre la Central para webmasters.
  2. Haz clic en la propiedad que verificaste como propia.
  3. En la lista Propietario verificado, haz clic en la opción para agregar un propietario.
  4. Proporciona el correo electrónico de la cuenta de servicio como propietario delegado. Puedes encontrarlo en dos lugares:
    • El campo client_email de la clave privada de JSON que descargaste cuando creaste el proyecto
    • La columna ID de cuenta de servicio de la vista cuentas de servicio de Developers Console
    La dirección de correo electrónico tiene un formato como el siguiente:
    my-service-account@project-name.google.com.iam.gserviceaccount.com
    Por ejemplo: my-service-account@test-project-42.google.com.iam.gserviceaccount.com

Obtén un token de acceso

Cada llamada a la API de Indexing debe autenticarse con un token OAuth que obtienes a cambio de la clave privada. Los token tienen una validez temporal. Google proporciona bibliotecas cliente de API a fin de obtener tokens OAuth para varios lenguajes.

Requisitos

Cuando envíes una solicitud a la API de Indexing, sigue estos pasos:

  1. Usa https://www.googleapis.com/auth/indexing como alcance.
  2. Utiliza uno de los extremos que se describen en Cómo usar la API.
  3. Incluye el token de acceso de la cuenta de servicio.
  4. Define el cuerpo de la solicitud como se describe en Cómo usar la API.

Ejemplos

En los siguientes ejemplos, se muestra el proceso para obtener un token de acceso OAuth.

Python

Obtiene un token OAuth token con la biblioteca cliente de la API de Google para Python:

from oauth2client.service_account import ServiceAccountCredentials
import httplib2

SCOPES = [ "https://www.googleapis.com/auth/indexing" ]
ENDPOINT = "https://indexing.googleapis.com/v3/urlNotifications:publish"

# service_account_file.json is the private key that you created for your service account.
JSON_KEY_FILE = "service_account_file.json"

credentials = ServiceAccountCredentials.from_json_keyfile_name(JSON_KEY_FILE, scopes=SCOPES)

http = credentials.authorize(httplib2.Http())

# Define contents here as a JSON string.
# This example shows a simple update request.
# Other types of requests are described in the next step.

content = """{
  \"url\": \"http://example.com/jobs/42\",
  \"type\": \"URL_UPDATED\"
}"""

response, content = http.request(ENDPOINT, method="POST", body=content)

Java

Obtiene un token OAuth con la biblioteca cliente de la API de Google para Java:

String scopes = "https://www.googleapis.com/auth/indexing";
String endPoint = "https://indexing.googleapis.com/v3/urlNotifications:publish";

JsonFactory jsonFactory = new JacksonFactory();

// service_account_file.json is the private key that you created for your service account.
InputStream in = IOUtils.toInputStream("service_account_file.json");

GoogleCredential credentials =
  GoogleCredential.fromStream(in, this.httpTransport, jsonFactory).createScoped(Collections.singleton(scopes));

GenericUrl genericUrl = new GenericUrl(endPoint);
HttpRequestFactory requestFactory = this.httpTransport.createRequestFactory();

// Define content here. The structure of the content is described in the next step.
String content = "{"
  + "\"url\": \"http://example.com/jobs/42\","
  + "\"type\": \"URL_UPDATED\","
  + "}";

HttpRequest request =
  requestFactory.buildPostRequest(genericUrl, ByteArrayContent.fromString("application/json", content));

credentials.initialize(request);
HttpResponse response = request.execute();
int statusCode = response.getStatusCode();

PHP

Obtiene un token OAuth con la biblioteca cliente de la API de Google para PHP:

require_once 'google-api-php-client/vendor/autoload.php';

$client = new Google_Client();

// service_account_file.json is the private key that you created for your service account.
$client->setAuthConfig('service_account_file.json');
$client->addScope('https://www.googleapis.com/auth/indexing');

// Get a Guzzle HTTP Client
$httpClient = $client->authorize();
$endpoint = 'https://indexing.googleapis.com/v3/urlNotifications:publish';

// Define contents here. The structure of the content is described in the next step.
$content = '{
  "url": "http://example.com/jobs/42",
  "type": "URL_UPDATED"
}';

$response = $httpClient->post($endpoint, [ 'body' => $content ]);
$status_code = $response->getStatusCode();

Node.js

Obtiene un token OAuth con la biblioteca cliente de Node.js:

var request = require("request");
var { google } = require("googleapis");
var key = require("./service_account.json");

const jwtClient = new google.auth.JWT(
  key.client_email,
  null,
  key.private_key,
  ["https://www.googleapis.com/auth/indexing"],
  null
);

jwtClient.authorize(function(err, tokens) {
  if (err) {
    console.log(err);
    return;
  }
  let options = {
    url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
    method: "POST",
    // Your options, which must include the Content-Type and auth headers
    headers: {
      "Content-Type": "application/json"
    },
    auth: { "bearer": tokens.access_token },
    // Define contents here. The structure of the content is described in the next step.
    json: {
      "url": "http://example.com/jobs/42",
      "type": "URL_UPDATED"
    }
  };
  request(options, function (error, response, body) {
    // Handle the response
    console.log(body);
  });
});

Además de mostrar el proceso para obtener un token, estos ejemplos muestran el punto en el que puedes agregar el cuerpo del mensaje de la solicitud. Para obtener información acerca de los tipos de llamada que puedes hacer y la estructura de los cuerpos del mensaje para ellas, consulta Cómo usar la API.