Skip to content

feat: add translation to en and ru #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
a0s wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add translation to en and ru #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 125 additions & 0 deletions README-en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Google Indexing API
**I'm glad you found this repository. If you find the tool useful, you can buy me a coffee on Buy Me A Coffee :)**

<a href="https://www.buymeacoffee.com/marekfoltas" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

This tool allows you to submit a bulk number of URLs for indexing using the Indexing API. If you don't know what the Indexing API is, you can find more information [here](https://developers.google.com/search/apis/indexing-api/v3/quickstart).

Why should you use it and why is it better than submitting URLs via Google Search Console?



* you can submit up to 200 URLs per day
* you can submit up to 100 URLs at once
* URLs submitted this way appear in the index much faster than with conventional methods

This is what Google says about it:

> We recommend using the Indexing API instead of sitemaps because it allows Googlebot to index pages faster than updating the sitemap and > signaling that fact to Google systems.

I use this on various sites (new, old) and every time the indexing is instant. Usually, all URLs (e.g., 200 new subpages) appear in the index within 24h after submitting the indexing request.

![indexing api](https://bootcampy.pl/wp-content/uploads/2022/03/18.png "Graph with indexed URLs")

![indexing api](https://bootcampy.pl/wp-content/uploads/2022/03/19.png "Graph with indexed URLs")

## Alright, but how do I run it?

### Create a service account in Google Cloud Platform

To use the Indexing API, you first need to create a service account in Google Cloud Platform:

* Go to [https://console.developers.google.com/iam-admin/serviceaccounts](https://console.developers.google.com/iam-admin/serviceaccounts)

* Click **CREATE PROJECT**

![create project](https://bootcampy.pl/wp-content/uploads/2022/03/1.png "Create project")

* Enter the name of your project and click **CREATE**

![create](https://bootcampy.pl/wp-content/uploads/2022/03/2.png "Create")

* Click **CREATE SERVICE ACCOUNT**

![create service account](https://bootcampy.pl/wp-content/uploads/2022/03/3.png "Create service account")

* Enter the account name, the rest can be skipped

![account name](https://bootcampy.pl/wp-content/uploads/2022/03/4.png "Enter account name")

* Save the name (E-mail) of the service account, as you will need to add it to GSC

* Next to your service account, click the three dots and **Manage keys**

![manage keys](https://bootcampy.pl/wp-content/uploads/2022/03/5.png "Manage keys")

* Create a new key

![create new key](https://bootcampy.pl/wp-content/uploads/2022/03/6.png "Create new key")

* JSON key type

![JSON key type](https://bootcampy.pl/wp-content/uploads/2022/03/7.png "JSON key type")

* The key should be saved to your disk (JSON file)

![download key to disk](https://bootcampy.pl/wp-content/uploads/2022/03/8.png "Download key to disk")


The downloaded key file will be used later; it is necessary for the tool to work correctly.


### Add the Indexing API to the project

* Go to the API library

![API library](https://bootcampy.pl/wp-content/uploads/2022/03/9.png "API library")

* Type “indexing api” in the search bar

![search bar](https://bootcampy.pl/wp-content/uploads/2022/03/10.png "Type indexing API in the search bar")

* select Indexing API from the list

![Indexing API](https://bootcampy.pl/wp-content/uploads/2022/03/11.png "Indexing API")

* enable the API

![Enable API](https://bootcampy.pl/wp-content/uploads/2022/03/12.png "Enable API")


### Add the service account to GSC

Once you have created the service account, add it as an **owner** to Google Search Console:

* log in to the Webmaster Central - [link](https://www.google.com/webmasters/verification/home)
* select the property to which you want to add the account
* add the previously created service account

![gsc](https://bootcampy.pl/wp-content/uploads/2022/03/13.png "Add service account to GSC")

### Run the tool

To run the tool, you will need Node.js and npm installed, which you can download [here](https://nodejs.org/en/).

Once you have that set up, download the repository. There is a file named service_account.json in the folder, which is just a placeholder. Delete it and replace it with the previously downloaded JSON key file. Rename the file to service_account.json.

Open the project, e.g., in Visual Studio Code ([link](https://code.visualstudio.com/)) and in the terminal, type:


![npm install](https://bootcampy.pl/wp-content/uploads/2022/03/16.png "npm install")

Once the installation is complete, type in the terminal:


![npm install](https://bootcampy.pl/wp-content/uploads/2022/03/17.png "npm install")

This will run the tool, and it will be available at [http://localhost:8000/](http://localhost:8000/)

In the form, paste the URLs you want to submit for indexing.

![form](https://bootcampy.pl/wp-content/uploads/2022/03/14.png "Form")

If you did everything correctly, you should get a 200 response after submitting the form. For a larger number of URLs, it's more convenient to check this in the browser console.

![response](https://bootcampy.pl/wp-content/uploads/2022/03/15.png "Response")
121 changes: 121 additions & 0 deletions README-ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Google Indexing API
**Рад, что вы нашли это репозитарий. Если считаете инструмент полезным, можете угостить меня кофе на Buy Me A Coffee :)**

<a href="https://www.buymeacoffee.com/marekfoltas" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

Инструмент позволяет массово отправлять адреса для индексации с помощью Indexing API. Если вы не знаете, что такое Indexing API, то больше информации найдете [здесь](https://developers.google.com/search/apis/indexing-api/v3/quickstart).

Почему стоит использовать этот метод и чем он лучше, чем отправка адресов через Google Search Console?

* можно отправить до 200 адресов в день
* можно отправить до 100 адресов за раз
* адреса, отправленные таким образом, появляются в индексе значительно быстрее, чем при использовании обычных методов

Вот что пишет об этом Google:

> Рекомендуем использовать интерфейс Indexing API вместо карт сайта, так как это обеспечивает более быстрое индексирование страниц Googlebot, чем при обновлении карты сайта и > сигнализации об этом системам Google.

Я использую это на различных сайтах (новых, старых), и каждый раз индексация происходит мгновенно. Обычно все адреса (например, 200 новых подстраниц) появляются в индексе в течение 24 часов после отправки запроса на индексацию.

![indexing api](https://bootcampy.pl/wp-content/uploads/2022/03/18.png "График проиндексированных URL-адресов")

![indexing api](https://bootcampy.pl/wp-content/uploads/2022/03/19.png "График проиндексированных URL-адресов")

## Хорошо, но как это запустить?

### Создайте аккаунт службы в Google Cloud Platform

Чтобы использовать интерфейс Indexing API, сначала нужно создать аккаунт службы в Google Cloud Platform:

* Перейдите по адресу [https://console.developers.google.com/iam-admin/serviceaccounts](https://console.developers.google.com/iam-admin/serviceaccounts)

* Нажмите **СОЗДАТЬ ПРОЕКТ**

![создать проект](https://bootcampy.pl/wp-content/uploads/2022/03/1.png "Создать проект")

* Введите название вашего проекта и нажмите **СОЗДАТЬ**

![создать](https://bootcampy.pl/wp-content/uploads/2022/03/2.png "Создать")

* Нажмите **СОЗДАТЬ АККАУНТ СЛУЖБЫ**

![создать аккаунт службы](https://bootcampy.pl/wp-content/uploads/2022/03/3.png "Создать аккаунт службы")

* Введите название аккаунта, остальное можно пропустить

![название аккаунта](https://bootcampy.pl/wp-content/uploads/2022/03/4.png "Введите название аккаунта")

* Сохраните название (E-mail) аккаунта службы, так как вам придется добавить его в GSC

* Рядом с вашим аккаунтом службы нажмите на три точки и выберите **Управление ключами**

![управление ключами](https://bootcampy.pl/wp-content/uploads/2022/03/5.png "Управление ключами")

* Создайте новый ключ

![создать новый ключ](https://bootcampy.pl/wp-content/uploads/2022/03/6.png "Создать новый ключ")

* Тип ключа JSON

![тип ключа JSON](https://bootcampy.pl/wp-content/uploads/2022/03/7.png "Тип ключа JSON")

* Ключ должен сохраниться на диске (файл json)

![скачивание ключа на диск](https://bootcampy.pl/wp-content/uploads/2022/03/8.png "Скачивание ключа на диск")


Скачанный файл с ключом будет использован позже, он необходим для правильной работы инструмента.

### Добавьте к проекту интерфейс Indexing API

* Перейдите в библиотеку интерфейсов API

![библиотека интерфейсов API](https://bootcampy.pl/wp-content/uploads/2022/03/9.png "Библиотека интерфейсов API")

* Введите в поиске “indexing api”

![поиск](https://bootcampy.pl/wp-content/uploads/2022/03/10.png "Введите в поиске indexing API")

* выберите из списка Indexing API

![Indexing API](https://bootcampy.pl/wp-content/uploads/2022/03/11.png "Indexing API")

* включите интерфейс

![включить интерфейс](https://bootcampy.pl/wp-content/uploads/2022/03/12.png "Включить интерфейс")


### Добавьте аккаунт службы в GSC

Как только у вас будет создан аккаунт службы, добавьте его как **владельца** в Google Search Console:

* войдите в Центр для вебмастеров - [ссылка](https://www.google.com/webmasters/verification/home)
* выберите услугу, к которой хотите добавить аккаунт
* добавьте ранее созданный аккаунт службы

![gsc](https://bootcampy.pl/wp-content/uploads/2022/03/13.png "Добавить аккаунт службы в GSC")

### Запустите инструмент

Чтобы запустить инструмент, вам потребуется установленный Node.js и npm, скачать можно [здесь](https://nodejs.org/en/).

Как только вы все настроите, скачайте репозиторий. В папке находится файл service_account.json, он только для примера. Удалите его и вставьте на его место ранее скачанный файл json с ключом. Переименуйте файл в service_account.json.

Откройте проект, например, в Visual Studio Code ([ссылка](https://code.visualstudio.com/)) и в терминале введите:

![npm install](https://bootcampy.pl/wp-content/uploads/2022/03/16.png "npm install")

После завершения установки введите в терминале:


![npm install](https://bootcampy.pl/wp-content/uploads/2022/03/17.png "npm install")

Таким образом вы запустите инструмент, он будет доступен по адресу [http://localhost:8000/](http://localhost:8000/)

В форму вставьте адреса, которые хотите отправить на индексацию.

![форма](https://bootcampy.pl/wp-content/uploads/2022/03/14.png "Форма")

Если все сделано правильно, после отправки формы вы получите ответ с кодом 200. При большом количестве адресов удобнее это просмотреть в консоли браузера.

![response](https://bootcampy.pl/wp-content/uploads/2022/03/15.png "Ответ")