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

Tài liệu này mô tả những việc bạn cầ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 đối với một tài sản nhất định để 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 thuộc tính đó.

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ư các định dạng dữ liệu web.

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

Tạo một dự án và thông tin đăng nhập cho khách hàng của bạn

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 mình và kích hoạt quyền truy cập vào API. Bạn có thể thực hiện việc này bằng cách sử dụng Bảng điều khiển API của Google để tạo một dự án. Đây là một tập hợp có tên gồm các chế độ cài đặt và thông tin về quyền truy cập vào API, đồng thời đăng ký ứng dụng của bạn.

Tất cả API Search Console (ngoại trừ API Công cụ kiểm thử) đều yêu cầu thông tin đăng nhập 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 dự án và lấy thông tin đăng nhập cho ứng dụng của bạn.

Tìm hiểu kiến thức cơ bản về Kiến trúc chuyển trạng thái đại diện (REST)

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

Nếu quyết định không sử dụng thư viện ứng dụng, bạn cần nắm được 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 mang lại cách tiếp cận thuận tiện và nhất quán để yêu cầu và sửa đổi dữ liệu.

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

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

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

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

Vì mọi tài nguyên API đều có URI riêng biệt có thể truy cập HTTP, nên REST cho phép lưu dữ liệu vào bộ nhớ đệm và được tối ưu hoá để hoạt động với cơ sở hạ tầng phân phối 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 hữu ích; vì các định nghĩa này bao gồm nội dung kỹ thuật cho GET, POST, PUT và DELETE.

REST trong Google Search Console API

Các thao tác của Google Search Console API liên kết trực tiếp với các động từ HTTP REST.

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

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

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

Tìm hiểu thông tin cơ bản về JSON

Google Search Console API 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, không phụ thuộc vào 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.