Điều kiện tiên quyết

Tài liệu này mô tả những việc bạn nên làm trước khi viết ứng dụng đầu tiên.

Tạo tài khoản Google

Bạn cần có Tài khoản Google để sử dụng API này. Tài khoản của bạn phải có quyền thích hợp trong Search Console trên một tài sản nhất định để có thể gọi phương thức đó trên tài sản đó. Ví dụ: để chạy searchAnalytics.query, bạn cần có quyền đọc trên tài sản đó.

Dùng thử Google Search Console

Tài liệu về API này giả định rằng bạn đã sử dụng Google Search Console và bạn đã quen thuộc với các khái niệm lập trình web cũng như định dạng dữ liệu web.

Nếu bạn chưa từng sử dụng Google Search Console, hãy thử qua giao diện người dùng trước khi bắt đầu lập trình. Mỗi API thể hiện chức năng của một báo cáo trong Search Console. Bạn nên đọc tài liệu cho báo cáo tương đương trước khi sử dụng API để hiểu dữ liệu mà bạn nhận được.

Tạo dự án và thông tin đăng nhập cho khách hàng

Trước khi có thể gửi yêu cầu đến Google Search Console, bạn cần cho Google biết về ứng dụng của bạn và kích hoạt quyền truy cập vào API. Bạn thực hiện việc này bằng cách sử dụng Google API Console để tạo dự án. Đây là một tập hợp gồm các chế độ cài đặt và thông tin truy cập API được đặt tên, đồng thời đăng ký ứng dụng của bạn.

Tất cả các API của Search Console ngoại trừ API Công cụ thử nghiệm đều yêu cầu thông tin xác thực OAuth2. Hướng dẫn bắt đầu nhanh về Python và Java cung cấp thông tin chi tiết về cách tạo một dự án và nhận thông tin xác thực cho ứng dụng.

Tìm hiểu kiến thức cơ bản về REST

Có hai cách để gọi API:

Nếu quyết định không sử dụng thư viện ứng dụng, bạn sẽ cần hiểu những kiến thức cơ bản về REST.

Kiến thức cơ bản về REST

REST là một kiểu kiến trúc phần mềm cung cấp một phương pháp nhất quán thuận tiện để yêu cầu và sửa đổi dữ liệu.

Thuật ngữ REST là tên viết tắt của "Đại diện chuyển trạng thái". Trong ngữ cảnh của API Google, thuật ngữ này đề cập đến việc sử dụng động từ HTTP để truy xuất và sửa đổi bản trình bày dữ liệu được Google lưu trữ.

Trong hệ thống RESTful, tài nguyên được lưu trữ trong kho lưu trữ dữ liệu; máy khách gửi yêu cầu rằng máy chủ thực hiện một hành động cụ thể (chẳng hạn như tạo, truy xuất, cập nhật hoặc xóa tài nguyên) và máy chủ thực hiện hành động đó và gửi phản hồi, thường ở dạng đại diện cho tài nguyên đã chỉ định.

Trong API RESTful của Google, ứng dụng chỉ định một thao tác bằng cách sử dụng động từ HTTP như POST, GET, PUT hoặc DELETE. Hàm này chỉ định tài nguyên theo một URI độc nhất trên toàn cầu có dạng như sau:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Vì tất cả tài nguyên API đều có các URI có thể truy cập HTTP duy nhất, nên REST cho phép lưu vào bộ nhớ đệm dữ liệu và được tối ưu hoá để hoạt động với cơ sở hạ tầng phân tán của web.

Bạn có thể thấy định nghĩa về phương thức trong tài liệu về các tiêu chuẩn HTTP 1.1; các định nghĩa này bao gồm thông số kỹ thuật cho GET, POST, PUT và DELETE.

REST trong API Google Search Console

Các hoạt động của API Search Console ánh xạ trực tiếp đến động từ HTTP trong REST.

Định dạng cho hầu hết các URI API của Google Search Console có dạng như sau:

VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters

Tập hợp đầy đủ các URI và động từ được sử dụng cho mỗi phương thức được cung cấp trong phần tổng quan Tài liệu tham khảo API Google Search Console.

Tìm hiểu kiến thức cơ bản về JSON

API Google Search Console trả về dữ liệu ở định dạng JSON.

JSON (Ký hiệu đối tượng JavaScript) là một định dạng dữ liệu phổ biến, độc lập về ngôn ngữ, cung cấp bản trình bày văn bản đơn giản của các cấu trúc dữ liệu tùy ý. Để biết thêm thông tin, hãy xem json.org.