Search Analytics: query

ต้องมีการให้สิทธิ์

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

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

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

ดูการเรียกใช้เมธอดนี้ในตัวอย่าง Python

API นี้มีข้อจํากัดภายในของ Search Console และไม่รับประกันว่าจะแสดงแถวข้อมูลทั้งหมด แต่จะเป็นแถวข้อมูลยอดนิยม

ดูขีดจำกัดจำนวนข้อมูลที่มี

ตัวอย่าง JSON POST 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}
ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
siteUrl string URL ของพร็อพเพอร์ตี้ตามที่กําหนดไว้ใน Search Console ตัวอย่าง: http://www.example.com/ (สําหรับพร็อพเพอร์ตี้ที่มีคํานําหน้า URL) หรือ sc-domain:example.com (สําหรับพร็อพเพอร์ตี้โดเมน)

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ (อ่านเพิ่มเติมเกี่ยวกับการรับรองและการให้สิทธิ์)

ขอบเขต
https://www.googleapis.com/auth/webmasters.readonly
https://www.googleapis.com/auth/webmasters

เนื้อหาของคำขอ

ในเนื้อหาคําขอ ให้ระบุข้อมูลที่มีโครงสร้างดังต่อไปนี้

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
startDate string [ต้องระบุ] วันที่เริ่มต้นของช่วงวันที่ที่ขอในรูปแบบ ปปปป-ดด-วว ในเขตเวลา PT (UTC - 7:00/8:00) ต้องน้อยกว่าหรือเท่ากับวันที่สิ้นสุด ค่านี้จะรวมอยู่ในช่วง
endDate string [ต้องระบุ] วันที่สิ้นสุดของช่วงวันที่ที่ขอในรูปแบบ ปปปป-ดด-วว ตามเขตเวลา PT (UTC - 7:00/8:00) ต้องมากกว่าหรือเท่ากับวันที่เริ่มต้น ค่านี้รวมอยู่ในช่วง
dimensions[] list [ไม่บังคับ] มิติข้อมูลตั้งแต่ 0 รายการขึ้นไปที่จะจัดกลุ่มผลลัพธ์ ระบบจะจัดกลุ่มผลลัพธ์ตามลําดับที่คุณระบุมิติข้อมูลเหล่านี้คุณสามารถใช้ชื่อมิติข้อมูลใดก็ได้ทั้งใน dimensionFilterGroups[].filters[].dimension และ "วันที่" ระบบจะรวมค่ามิติข้อมูลการจัดกลุ่มเพื่อสร้างคีย์ที่ไม่ซ้ำกันสําหรับแถวผลลัพธ์แต่ละแถว หากไม่ได้ระบุมิติข้อมูล ค่าทั้งหมดจะรวมเป็นแถวเดียว ไม่มีการจำกัดจำนวนมิติข้อมูลที่คุณสามารถจัดกลุ่มได้ แต่คุณไม่สามารถจัดกลุ่มตามมิติข้อมูลเดียวกัน 2 ครั้งได้ ตัวอย่าง: [country, device]
searchType string เลิกใช้งานแล้ว ให้ใช้ type แทน
type string [ไม่บังคับ] กรองผลลัพธ์เป็นประเภทต่อไปนี้
  • "discover": ผลการค้นหาใน Discover
  • "googleNews": ผลลัพธ์จาก news.google.com และแอป Google News ใน Android และ iOS ไม่รวมผลการค้นหาจากแท็บ "ข่าว" ใน Google Search
  • "news": ผลการค้นหาจากแท็บ "ข่าวสาร" ใน Google Search
  • "image": ผลการค้นหาจากแท็บ "รูปภาพ" ใน Google Search
  • "video": ผลการค้นหาวิดีโอ
  • "web": [ค่าเริ่มต้น] กรองผลการค้นหาไปยังแท็บแบบรวม ("ทั้งหมด") ใน Google Search ไม่รวมผลการค้นหาใน Discover หรือ Google News
dimensionFilterGroups[] list [ไม่บังคับ] กลุ่มตัวกรองอย่างน้อย 1 กลุ่มที่จะใช้กับค่าการจัดกลุ่มมิติข้อมูล กลุ่มตัวกรองทั้งหมดต้องตรงกันเพื่อให้ระบบแสดงแถวในคำตอบ ภายในกลุ่มตัวกรองกลุ่มเดียว คุณสามารถระบุได้ว่าตัวกรองทั้งหมดต้องตรงกัน หรือต้องตรงกันอย่างน้อย 1 รายการ
dimensionFilterGroups[].groupType string ตัวกรองทั้งหมดในกลุ่มนี้ต้องแสดงผลเป็น "จริง" ("and") หรือจะแสดงผลเป็น "จริง" อย่างน้อย 1 รายการ (ยังไม่รองรับ)

ค่าที่ยอมรับมีดังนี้
  • "and": ตัวกรองทั้งหมดในกลุ่มต้องแสดงผลเป็น "จริง" เพื่อให้กลุ่มตัวกรองเป็น "จริง"
dimensionFilterGroups[].filters[] list [ไม่บังคับ] ตัวกรองอย่างน้อย 0 รายการเพื่อทดสอบกับแถว ตัวกรองแต่ละรายการประกอบด้วยชื่อมิติข้อมูล โอเปอเรเตอร์ และค่า ความยาวสูงสุด 4,096 อักขระ ตัวอย่าง 
country equals FRA
query contains mobile use
device notContains tablet
dimensionFilterGroups[].filters[].dimension string มิติข้อมูลที่ใช้ตัวกรองนี้ คุณสามารถกรองตามมิติข้อมูลใดก็ได้ที่แสดงที่นี่ แม้ว่าจะไม่ได้จัดกลุ่มตามมิติข้อมูลนั้นก็ตาม

ค่าที่ยอมรับมีดังนี้
  • "country": กรองตามประเทศที่ระบุตามที่ระบุโดยรหัสประเทศ 3 ตัวอักษร (ISO 3166-1 alpha-3)
  • "device": กรองผลลัพธ์ตามประเภทอุปกรณ์ที่ระบุ ค่าที่รองรับ:
    • DESKTOP
    • อุปกรณ์เคลื่อนที่
    • TABLET
  • "page": กรองตามสตริง URI ที่ระบุ
  • "query": กรองตามสตริงการค้นหาที่ระบุ
  • "searchAppearance": กรองตามฟีเจอร์ผลการค้นหาที่เฉพาะเจาะจง หากต้องการดูรายการค่าที่ใช้ได้ ให้เรียกใช้การค้นหาที่จัดกลุ่มตาม "searchAppearance" รายการค่าและคําอธิบายทั้งหมดมีอยู่ในเอกสารประกอบสําหรับความช่วยเหลือด้วย
dimensionFilterGroups[].filters[].operator string [ไม่บังคับ] วิธีที่ค่าที่ระบุต้องตรงกับ (หรือไม่ตรงกับ) ค่ามิติข้อมูลของแถว

ค่าที่ยอมรับมีดังนี้
  • "contains": ค่าแถวต้องมีหรือเท่ากับนิพจน์ของคุณ (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่)
  • "equals": [ค่าเริ่มต้น] นิพจน์ต้องเท่ากับค่าแถวทุกประการ (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่สำหรับมิติข้อมูลหน้าเว็บและการค้นหา)
  • "notContains": ค่าแถวต้องไม่มีนิพจน์ของคุณเป็นสตริงย่อยหรือการจับคู่ที่สมบูรณ์ (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่)
  • "notEquals": นิพจน์ต้องไม่ตรงกับค่าแถวทุกประการ (คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่สำหรับมิติข้อมูลหน้าเว็บและการค้นหา)
  • "includingRegex": นิพจน์ทั่วไป รูปแบบไวยากรณ์ RE2 ที่ต้องตรงกัน
  • "excludingRegex": นิพจน์ทั่วไป รูปแบบไวยากรณ์ RE2 ที่ต้องไม่ตรงกัน
dimensionFilterGroups[].filters[].expression string ค่าสำหรับตัวกรองที่จะจับคู่หรือยกเว้น ทั้งนี้ขึ้นอยู่กับโอเปอเรเตอร์
aggregationType string

[ไม่บังคับ] วิธีรวบรวมข้อมูล หากรวบรวมตามพร็อพเพอร์ตี้ ระบบจะรวบรวมข้อมูลทั้งหมดของพร็อพเพอร์ตี้เดียวกัน หากรวบรวมตามหน้าเว็บ ระบบจะรวบรวมข้อมูลทั้งหมดตาม URI ของหน้า Canonical หากกรองหรือจัดกลุ่มตามหน้าเว็บ ให้เลือก "อัตโนมัติ" หรือจะรวบรวมข้อมูลตามพร็อพเพอร์ตี้หรือตามหน้าเว็บก็ได้ ทั้งนี้ขึ้นอยู่กับวิธีที่คุณต้องการให้ระบบคํานวณข้อมูล ดูเอกสารประกอบของความช่วยเหลือเพื่อดูวิธีคํานวณข้อมูลที่แตกต่างกันตามเว็บไซต์กับตามหน้าเว็บ

หมายเหตุ: หากจัดกลุ่มหรือกรองตามหน้า คุณจะรวมตามพร็อพเพอร์ตี้ไม่ได้

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

ค่าที่ยอมรับได้ มีดังนี้
  • "auto": [ค่าเริ่มต้น] ปล่อยให้บริการตัดสินใจเลือกประเภทการรวมที่เหมาะสม
  • "byNewsShowcasePanel": รวมค่าตามแผง News Showcase ต้องใช้ร่วมกับตัวกรอง NEWS_SHOWCASE searchAppearance และ type=discover หรือ type=googleNews หากจัดกลุ่มตามหน้าเว็บ กรองตามหน้าเว็บ หรือกรองไปยัง searchAppearance อื่น คุณจะไม่รวมข้อมูลตาม byNewsShowcasePanel ได้
  • "byPage": รวมค่าตาม URI
  • "byProperty": รวมค่าตามพร็อพเพอร์ตี้ ไม่รองรับ type=discover หรือ type=googleNews
rowLimit integer [ไม่บังคับ ช่วงที่ใช้ได้คือ 1-25,000 ค่าเริ่มต้นคือ 1,000] จํานวนแถวสูงสุดที่จะแสดงผล หากต้องการเลื่อนดูผลการค้นหาทีละหน้า ให้ใช้การเลื่อน startRow
startRow integer [ไม่บังคับ ค่าเริ่มต้นคือ 0] ดัชนีฐาน 0 ของแถวแรกในการตอบกลับ ต้องเป็นตัวเลขที่ไม่ใช่ค่าลบ หาก startRow มากกว่าจํานวนผลลัพธ์สําหรับการค้นหา การตอบกลับจะเป็นการตอบกลับที่ประสบความสําเร็จโดยมีแถวเป็น 0
dataState string [ไม่บังคับ] หากเป็น "all" (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) ข้อมูลจะรวมข้อมูลล่าสุด หาก "สุดท้าย" (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) หรือหากละพารามิเตอร์นี้ ข้อมูลที่ส่งคืนจะรวมเฉพาะข้อมูลที่สรุปผลเท่านั้น

คำตอบ

ระบบจะจัดกลุ่มผลลัพธ์ตามมิติข้อมูลที่ระบุในคําขอ ระบบจะจัดกลุ่มค่าทั้งหมดที่มีชุดค่ามิติข้อมูลเดียวกันไว้ในแถวเดียว เช่น หากคุณจัดกลุ่มตามมิติข้อมูลประเทศ ผลลัพธ์ทั้งหมดสําหรับ "usa" จะจัดกลุ่มไว้ด้วยกัน ผลลัพธ์ทั้งหมดสําหรับ "mdv" จะจัดกลุ่มไว้ด้วยกัน และอื่นๆ หากคุณจัดกลุ่มตามประเทศและอุปกรณ์ ระบบจะจัดกลุ่มผลการค้นหาทั้งหมดสําหรับ "สหรัฐอเมริกา, แท็บเล็ต", ผลการค้นหาทั้งหมดสําหรับ "สหรัฐอเมริกา, อุปกรณ์เคลื่อนที่" และอื่นๆ ดูเอกสารประกอบของรายงาน Search Analytics เพื่อดูรายละเอียดเกี่ยวกับวิธีคํานวณการคลิก การแสดงผล และอื่นๆ รวมถึงความหมายของข้อมูลเหล่านี้

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

ดูจำนวนค่าสูงสุดที่ระบบแสดงผลได้ในคำขอของพร็อพเพอร์ตี้ rowLimit

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
rows[] list รายการแถวที่จัดกลุ่มตามค่าคีย์ตามลำดับที่ระบุในการค้นหา
rows[].keys[] list รายการค่ามิติข้อมูลสำหรับแถวนั้นที่จัดกลุ่มตามมิติข้อมูลในคำขอตามลำดับที่ระบุไว้ในคำขอ
rows[].clicks double คลิกจํานวนแถว
rows[].impressions double จํานวนการแสดงผลของแถว
rows[].ctr double อัตราการคลิกผ่าน (CTR) ของแถว ค่าอยู่ในช่วง 0 ถึง 1.0 (รวม)
rows[].position double อันดับเฉลี่ยในผลการค้นหา
responseAggregationType string วิธีรวบรวมผลลัพธ์ ดูเอกสารประกอบของความช่วยเหลือเพื่อดูวิธีคำนวณข้อมูลที่แตกต่างกันตามเว็บไซต์และตามหน้าเว็บ

ค่าที่ยอมรับมีดังนี้
  • "auto"
  • "byPage": ผลการค้นหาได้รับการรวบรวมตามหน้าเว็บ
  • "byProperty": ผลลัพธ์ที่รวบรวมตามพร็อพเพอร์ตี้

ลองใช้งาน

ใช้โปรแกรมสำรวจ API ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลจริงและดูการตอบกลับ