API Reference

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

  • Search Analytics - ค้นหาข้อมูลการเข้าชมเว็บไซต์ของคุณ
  • แผนผังเว็บไซต์ - แสดงแผนผังเว็บไซต์ทั้งหมด ขอข้อมูลเกี่ยวกับแผนผังเว็บไซต์ที่ต้องการ และส่งแผนผังเว็บไซต์ไปยัง 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 แถวที่จัดกลุ่มตามคีย์แถว (มิติข้อมูล) ที่คุณกําหนด คุณต้องกําหนดช่วงวันที่อย่างน้อย 1 วัน

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

ผลลัพธ์จะจัดเรียงตามจํานวนคลิกจากมากไปน้อย หาก 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 เรียกดูข้อมูลเกี่ยวกับแผนผังเว็บไซต์ที่เฉพาะเจาะจง
list GET  /sites/siteUrl/sitemaps แสดงรายการรายการ Sitemap ที่ส่งสําหรับเว็บไซต์นี้ หรือรวมอยู่ในไฟล์ดัชนี Sitemap (หาก 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"}