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
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
startDate string [ต้องระบุ] วันที่เริ่มต้นของช่วงวันที่ที่ขอในรูปแบบ YYYY-MM-DD ในเวลา PT (UTC - 7:00/8:00) ต้องน้อยกว่าหรือเท่ากับวันที่สิ้นสุด ค่านี้จะรวมอยู่ในช่วง
endDate string [ต้องระบุ] วันที่สิ้นสุดของช่วงวันที่ที่ขอในรูปแบบ ปปปป-ดด-วว ตามเวลา PT (UTC - 7:00/8:00) ต้องมากกว่าหรือเท่ากับวันที่เริ่มต้น ค่านี้จะรวมอยู่ในช่วง
dimensions[] list [ไม่บังคับ] มีมิติข้อมูล 0 รายการขึ้นไปในการจัดกลุ่มผลลัพธ์ผลลัพธ์จะถูกจัดกลุ่มตามลำดับที่คุณระบุมิติข้อมูลเหล่านี้คุณใช้ชื่อมิติข้อมูลใดก็ได้ใน dimensionFilterGroups[].filters[].dimension รวมทั้ง "วันที่"ระบบจะรวมค่ามิติข้อมูลการจัดกลุ่มเพื่อสร้างคีย์ที่ไม่ซ้ำกันสำหรับแถวผลลัพธ์แต่ละแถว หากไม่ได้ระบุมิติข้อมูล ระบบจะรวมค่าทั้งหมดไว้ในแถวเดียว คุณจัดกลุ่มมิติข้อมูลได้ไม่จำกัดจำนวน แต่จะจัดกลุ่มตามมิติข้อมูลเดียวกัน 2 ครั้งไม่ได้ เช่น [ประเทศ อุปกรณ์]
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 กลุ่มภายในกลุ่มตัวกรองกลุ่มเดียว
dimensionFilterGroups[].groupType string ตัวกรองทั้งหมดในกลุ่มนี้ต้องแสดงค่าเป็น "จริง" ("และ") หรือระบุอย่างน้อย 1 รายการให้แสดงค่า "จริง" (ยังไม่รองรับ)

ค่าที่ยอมรับมีดังนี้
  • "and": ตัวกรองทั้งหมดในกลุ่มจะต้องคืนค่าเป็น true สำหรับกลุ่มตัวกรอง ไม่เป็นจริง
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": กรองผลการค้นหาตามประเภทอุปกรณ์ที่ระบุ ค่าที่รองรับ:
    • เดสก์ท็อป
    • อุปกรณ์เคลื่อนที่
    • แท็บเล็ต
  • "page": กรองสตริง URI ที่ระบุ
  • "query": กรองตามสตริงการค้นหาที่ระบุ
  • "searchAppearance": กรองตามฟีเจอร์ผลการค้นหาที่เฉพาะเจาะจง หากต้องการดูรายการค่าที่ใช้ได้ ให้เรียกใช้การค้นหาที่จัดกลุ่มตาม "searchAppearance"
dimensionFilterGroups[].filters[].operator string [ไม่บังคับ] ค่าที่ระบุต้องตรงกับ (หรือไม่ตรงกับ) ค่ามิติข้อมูลสำหรับแถวอย่างไร

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

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

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

หากคุณระบุค่าอื่นนอกเหนือจากอัตโนมัติ ประเภทการรวมในผลลัพธ์จะตรงกับประเภทที่ขอ หรือหากคุณขอประเภทที่ไม่ถูกต้อง คุณจะได้รับข้อผิดพลาด 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 [ไม่บังคับ] หากเป็น "ทั้งหมด" (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) ข้อมูลจะมีข้อมูลสดด้วย หากค่า "Final" (ไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่) หรือหากไม่มีการละพารามิเตอร์นี้ ข้อมูลที่แสดงผลจะรวมเฉพาะข้อมูลที่สรุปผลเท่านั้น

คำตอบ

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

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

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

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
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 Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้ในข้อมูลสดและดูการตอบสนอง