API Reference

Search Console API มีบริการต่อไปนี้

  • การวิเคราะห์การค้นหา - ค้นหาข้อมูลการเข้าชมเว็บไซต์ของคุณ
  • แผนผังเว็บไซต์ แสดงแผนผังเว็บไซต์ทั้งหมด ขอข้อมูลเกี่ยวกับแผนผังเว็บไซต์ที่เฉพาะเจาะจง และส่งแผนผังเว็บไซต์ไปยัง Google
  • Sites - แสดงรายการ/เพิ่ม/นำพร็อพเพอร์ตี้ออกจากบัญชี Search Console ของคุณ
  • การตรวจสอบ URL - ตรวจสอบสถานะของหน้าในดัชนีของ Google (เทียบเท่ากับการตรวจสอบ URL ใน Search Console)

Analytics สำหรับการค้นหา

ดูรายละเอียดทรัพยากรของ Search Analytics ที่หน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/webmasters/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
คำค้นหา POST  /sites/siteUrl/searchAnalytics/query

ค้นหาข้อมูลการเข้าชมจากการค้นหาด้วยตัวกรองและพารามิเตอร์ที่กำหนด วิธีนี้จะแสดงแถวเป็น 0 แถวขึ้นไปซึ่งจัดกลุ่มตามคีย์แถว (มิติข้อมูล) ที่คุณกำหนด คุณต้องกำหนดช่วงวันที่อย่างน้อยหนึ่งวัน

เมื่อวันที่เป็นหนึ่งในมิติข้อมูล ระบบจะไม่รวมวันที่ไม่มีข้อมูลออกจากรายการผลลัพธ์ หากต้องการดูว่าวันใดมีข้อมูล ให้ทำการค้นหาโดยไม่มีตัวกรองที่จัดกลุ่มตามวันที่สำหรับช่วงวันที่ที่สนใจ

ผลลัพธ์จะจัดเรียงตามจำนวนคลิกจากมากไปน้อย หากแถว 2 แถวมีจำนวนคลิกเท่ากัน ระบบจะจัดเรียงอย่างไร

ดูตัวอย่าง Python สำหรับการเรียกเมธอดนี้

ตัวอย่าง JSON POST: 
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"]
}

Sitemap

สำหรับรายละเอียดทรัพยากร Sitemap โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/webmasters/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
ลบ DELETE  /sites/siteUrl/sitemaps/feedpath ลบ Sitemap ออกจากเว็บไซต์
รับ GET  /sites/siteUrl/sitemaps/feedpath เรียกดูข้อมูลเกี่ยวกับ Sitemap ที่เฉพาะเจาะจง
list GET  /sites/siteUrl/sitemaps แสดงรายการแผนผังเว็บไซต์ที่ส่งสำหรับเว็บไซต์นี้ หรือรวมอยู่ในไฟล์ดัชนีแผนผังเว็บไซต์ (หากระบุ sitemapIndex ในคำขอ)
ส่ง PUT  /sites/siteUrl/sitemaps/feedpath ส่ง Sitemap สำหรับเว็บไซต์

Sites

สำหรับรายละเอียดทรัพยากรของ Sites โปรดดูหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/webmasters/v3 เว้นแต่จะระบุไว้เป็นอย่างอื่น
เพิ่ม PUT  /sites/siteUrl เพิ่มเว็บไซต์ลงในชุดเว็บไซต์ของผู้ใช้ใน Search Console
ลบ DELETE  /sites/siteUrl นำเว็บไซต์ออกจากชุดเว็บไซต์ Search Console ของผู้ใช้
รับ GET  /sites/siteUrl เรียกดูข้อมูลเกี่ยวกับเว็บไซต์ที่เฉพาะเจาะจง
list GET  /sites แสดงเว็บไซต์ Search Console ของผู้ใช้

การตรวจสอบ URL

โปรดดูรายละเอียดทรัพยากรการตรวจสอบ URL ในหน้าการแสดงทรัพยากร

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://searchconsole.googleapis.com/v1
index.inspect POST /urlInspection/index:inspect

ข้อมูลเกี่ยวกับ URL ที่ระบุในดัชนีของ Google

ตัวอย่าง JSON POST: 
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}