API Reference

API Search Console cung cấp các dịch vụ sau:

  • Phân tích tìm kiếm – Truy vấn dữ liệu lưu lượng truy cập cho trang web của bạn.
  • Sơ đồ trang web – Liệt kê tất cả các sơ đồ trang web của bạn, yêu cầu thông tin về một sơ đồ trang web cụ thể rồi gửi một sơ đồ trang web cho Google.
  • Trang web – Liệt kê/thêm/xoá tài sản khỏi tài khoản Search Console.
  • Kiểm tra URL – Kiểm tra trạng thái của một trang trong chỉ mục của Google (tương đương với quy trình Kiểm tra URL trong Search Console).

Phân tích tìm kiếm

Để biết thông tin chi tiết về Tài nguyên phân tích tìm kiếm, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ phi có lưu ý khác
cụm từ tìm kiếm POST  /sites/siteUrl/searchAnalytics/query

Truy vấn dữ liệu lưu lượng truy cập tìm kiếm của bạn bằng bộ lọc và thông số mà bạn xác định. Phương thức này trả về 0 hoặc nhiều hàng hơn được nhóm theo các khóa hàng (phương diện) mà bạn xác định. Bạn phải xác định phạm vi ngày của một hoặc nhiều ngày.

Khi ngày là một trong các phương diện, bất cứ ngày nào không có dữ liệu sẽ bị loại khỏi danh sách kết quả. Để tìm hiểu ngày nào có dữ liệu, hãy xuất một truy vấn không có bộ lọc theo ngày, trong phạm vi ngày mà bạn quan tâm.

Kết quả được sắp xếp theo số lượt nhấp giảm dần. Nếu hai hàng có cùng số lượt nhấp, thì các hàng đó được sắp xếp theo cách tuỳ ý.

Hãy xem mẫu python để gọi phương thức này.

Ví dụ về yêu cầu POST qua JSON: 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Sơ đồ trang web

Để biết thông tin chi tiết về Tài nguyên sơ đồ trang web, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ phi có lưu ý khác
xóa DELETE  /sites/siteUrl/sitemaps/feedpath Xoá sơ đồ trang web khỏi trang web này.
tải GET  /sites/siteUrl/sitemaps/feedpath Truy xuất thông tin về một sơ đồ trang web cụ thể.
list GET  /sites/siteUrl/sitemaps Hãy liệt kê các mục trong sơ đồ trang web đã gửi cho trang web này, hoặc đưa vào tệp chỉ mục sơ đồ trang web (nếu sitemapIndex được chỉ định trong yêu cầu).
gửi PUT  /sites/siteUrl/sitemaps/feedpath Gửi sơ đồ trang web cho một trang web.

Sites

Để biết thông tin chi tiết về Tài nguyên trang web, vui lòng xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ phi có lưu ý khác
thêm PUT  /sites/siteUrl Thêm một trang web vào tập hợp trang web của người dùng trong Search Console.
xóa DELETE  /sites/siteUrl Xoá một trang web khỏi tập hợp trang web của người dùng trong Search Console.
tải GET  /sites/siteUrl Truy xuất thông tin về trang web cụ thể.
list GET  /sites Liệt kê các trang web của người dùng trong Search Console.

Kiểm tra URL

Để biết thông tin chi tiết về tài nguyên Kiểm tra URL, vui lòng xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

Thông tin về URL được cung cấp trong chỉ mục của Google.

Ví dụ về yêu cầu POST qua JSON: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}