รายงานคำค้นหา

Report มีผลการวิเคราะห์ App Bundle รายการเดียว รวมถึงผลการตรวจสอบการปฏิบัติตามข้อกำหนดและผลการตรวจสอบข้อมูล ข้อมูลเกือบทั้งหมดที่แสดงผ่านหน้าการปฏิบัติตามข้อกำหนดและการตรวจสอบข้อมูลของ Checks Console สามารถเข้าถึงได้โดยใช้โปรแกรมผ่านรายงาน

Checks API มีเมธอดมาตรฐาน Get และ List สำหรับเข้าถึงรายงาน ดังนี้

เลือกช่องที่จะแสดง

เนื่องจากรายงานมีข้อมูลจำนวนมาก ระบบจึงแสดงเฉพาะฟิลด์ name และ resultsUri โดยค่าเริ่มต้น หากต้องการแสดงชุดฟิลด์อื่น ให้ระบุฟิลด์เหล่านั้น อย่างชัดเจนในพารามิเตอร์การค้นหา URL ของ fields

ตัวอย่าง

GET https://checks.googleapis.com/v1alpha/accounts/123/apps/456/reports/789?fields=name,checks(type,state)

ค่าที่ส่งคืน:

{
  "name": "accounts/123/apps/456/reports/789",
  "checks": [
    {
      "type": "PRIVACY_POLICY_UPDATE_DATE_RECENT",
      "state": "PASSED"
    },
    ...
  ]
}

คุณแสดงฟิลด์ที่ซ้อนกันได้โดยใช้ไวยากรณ์แบบจุดหรือโดยการใส่ฟิลด์ไว้ในวงเล็บ

ตัวอย่างเช่น

fields=checks.type,checks.state

เทียบเท่ากับ

fields=checks(type,state)

นอกจากนี้ คุณยังใช้วงเล็บซ้อนกันได้ด้วย เช่น

fields=checks(type,state,evidence(permissions,sdks))

ซึ่งช่วยให้เขียนนิพจน์ได้กระชับยิ่งขึ้น

ค่าของพารามิเตอร์การค้นหา fields เรียกอีกอย่างว่ามาสก์ฟิลด์ ดูข้อมูลเพิ่มเติมได้ที่มาสก์ของช่อง

ตัวอย่าง FieldMask เพิ่มเติมสำหรับเมธอด Get และ List มีดังนี้

ดาวน์โหลด

นิพจน์ เอาต์พุต
* แสดงผลช่องทั้งหมด
name,checks แสดงผล name และฟิลด์ที่ซ้อนกันทั้งหมดของ checks
name,checks(type,state) การคืนสินค้า name, checks.type และ checks.state
name,dataMonitoring แสดงผล name และฟิลด์ที่ซ้อนกันทั้งหมดของ dataMonitoring

รายการ

นิพจน์ เอาต์พุต
* แสดงผลช่องทั้งหมด
reports(name,checks) แสดงผล name และฟิลด์ที่ซ้อนกันทั้งหมดของ checks
reports(name,checks(type,state)) การคืนสินค้า name, checks.type และ checks.state
reports(name,dataMonitoring) แสดงผล name และฟิลด์ที่ซ้อนกันทั้งหมดของ dataMonitoring

กรองรายงาน

คุณสามารถกรองรายงานที่ส่งคืนโดยเมธอด List ได้โดยส่งนิพจน์ตัวกรอง โดยใช้พารามิเตอร์การค้นหา URL filter

ตัวอย่างเช่น

นิพจน์ เอาต์พุต
appBundle.releaseType = PRE_RELEASE แสดงเฉพาะรายงานของ App Bundle ก่อนเผยแพร่
appBundle.releaseType = PUBLIC แสดงเฉพาะรายงานของ App Bundle สาธารณะ
appBundle.codeReferenceId = abc123 แสดงรายงานที่ codeReferenceId เท่ากับ abc123

ระบบไม่รองรับการกรองตามเส้นทางฟิลด์ต่อไปนี้

  • checks.evidence.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
  • checks.evidence.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
  • checks.evidence.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
  • checks.evidence.privacyPolicyTexts.policyFragment.htmlContent
  • checks.evidence.sdkIssues.sdk.id
  • dataMonitoring.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
  • dataMonitoring.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
  • dataMonitoring.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
  • dataMonitoring.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.sourceUri
  • dataMonitoring.permissions.metadata.lastDetectedAppVersion
  • resultsUri

ดูAIP-160 เพื่อดูวิธีสร้างนิพจน์ตัวกรองเพิ่มเติม

ตรวจสอบตัวกรองภายในรายงาน

คุณสามารถกรองการตรวจสอบภายในรายงานได้โดยส่งนิพจน์ตัวกรองโดยใช้พารามิเตอร์การค้นหา URL checksFilter เฉพาะการตรวจสอบที่ตรงกับนิพจน์ตัวกรอง เท่านั้นที่จะรวมอยู่ในการตอบกลับ พารามิเตอร์นี้รองรับทั้งเมธอด List และ Get

ตัวอย่างเช่น

นิพจน์ เอาต์พุต
state = FAILED รวมเฉพาะการตรวจสอบที่ไม่สำเร็จ
citations.type:GDPR รวมเฉพาะการตรวจสอบที่เกี่ยวข้องกับ GDPR
state = FAILED AND citations.type:GDPR รวมเฉพาะการตรวจสอบที่ไม่สำเร็จที่เกี่ยวข้องกับ GDPR
regionCodes:CA รวมเฉพาะเช็คที่เกี่ยวข้องกับภูมิภาคแคนาดา
state = FAILED AND severity = PRIORITY รวมเฉพาะการตรวจสอบที่มีลำดับความสำคัญที่ไม่สำเร็จ

ระบบไม่รองรับการกรองตามเส้นทางฟิลด์ต่อไปนี้

  • evidence.dataTypes.dataTypeEvidence.endpoints.attributedSdks.sdk.id
  • evidence.dataTypes.dataTypeEvidence.endpoints.endpointDetails.endpoint.domain
  • evidence.dataTypes.dataTypeEvidence.privacyPolicyTexts.policyFragment.htmlContent
  • evidence.privacyPolicyTexts.policyFragment.htmlContent
  • evidence.sdkIssues.sdk.id

ดูAIP-160 เพื่อดูวิธีสร้างนิพจน์ตัวกรองเพิ่มเติม

การใส่เลขหน้า

โดยค่าเริ่มต้น List เมธอดจะแสดงผลรายงานอย่างน้อย 10 รายงาน คุณเปลี่ยนได้ โดยตั้งค่าpageSizeพารามิเตอร์การค้นหา URL ค่าสูงสุดคือ 50

เมธอด List จะแสดง nextPageToken เมื่อมีผลลัพธ์เพิ่มเติมที่ต้อง ดึงข้อมูล

{
  "reports": [
    ...
  ],
  "nextPageToken": "CAEQ0ITI8K7ngAMaIDY3MThjNjQ3NGZmNzBhZGI4NWI5NjAyN2ViZmQ5MWVh"
}

ส่งโทเค็นนี้ไปยังเมธอด List โดยใช้พารามิเตอร์การค้นหา URL pageToken เพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป