API Reference

Search Console API 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ể và 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 của bạn.
  • 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 công cụ 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 trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ khi có ghi chú 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 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 được nhóm theo các khoá hàng (phương diện) mà bạn xác định. Bạn phải xác định phạm vi ngày gồm một hoặc nhiều ngày.

Khi ngày là một trong các phương diện, thì bất kỳ 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 đưa ra truy vấn mà không dùng bộ lọc được nhóm theo ngày, cho 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 2 hàng có cùng số lượt nhấp, chúng sẽ đượ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ề POST cho 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 trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ khi có ghi chú khác
xóa DELETE  /sites/siteUrl/sitemaps/feedpath Xoá một sơ đồ trang web khỏi trang web này.
nhận GET  /sites/siteUrl/sitemaps/feedpath Truy xuất thông tin về một sơ đồ trang web cụ thể.
list GET  /sites/siteUrl/sitemaps Liệt kê các mục sơ đồ trang web được gửi cho trang web này hoặc đượ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.

Trang web

Để biết thông tin chi tiết về Tài nguyên Sites, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Nội dung mô tả
URI liên quan đến https://www.googleapis.com/webmasters/v3, trừ khi có ghi chú khác
thêm PUT  /sites/siteUrl Thêm một trang web vào nhóm trang web của người dùng trong Search Console.
xóa DELETE  /sites/siteUrl Xoá một trang web khỏi nhóm trang web của người dùng trong Search Console.
nhận 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, hãy xem trang nội dung trình bày về tài nguyên.

Phương thức Yêu cầu HTTP Nội dung 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ề POST cho JSON: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}