อัปโหลดแอปเพื่อวิเคราะห์

Checks API สามารถวิเคราะห์แอป Android และแอป iOS ก่อนเผยแพร่ เพื่อให้คุณเห็นภาพรวมพฤติกรรมการเก็บรวบรวมและแชร์ข้อมูลของแอป รวมถึงปัญหาที่อาจเกิดขึ้นเกี่ยวกับการปฏิบัติตามข้อกำหนด ก่อนที่จะเปิดตัวแอปต่อสาธารณะ

การเริ่มต้นอย่างรวดเร็วนี้จะแสดงวิธีอัปโหลดแอปโดยใช้ gcloud CLI และคำสั่ง cURL

ข้อกำหนดเบื้องต้น

ก่อนเริ่มต้น โปรดตรวจสอบว่าคุณสามารถส่งคำขอที่ได้รับอนุญาตโดยใช้ คู่มือการให้สิทธิ์ของเรา

เตรียม App Bundle

Android

  1. สร้างไฟล์ APK หรือ AAB สำหรับแอป

    ดูวิธีการได้ที่สร้างและเรียกใช้แอปใน เอกสารประกอบของ Android

iOS

  1. ใน Xcode ให้เลือกโปรไฟล์การจัดสรรสำหรับแอปเป้าหมาย

  2. จากเมนูแบบเลื่อนลงที่ปรากฏขึ้น ให้คลิก Product > Archive เลือกไฟล์เก็บถาวรล่าสุด แล้วคลิก Distribute App

  3. ในหน้าต่างที่ปรากฏขึ้น ให้คลิก Development > Next

  4. (ไม่บังคับ) หากต้องการสร้างบิลด์ได้รวดเร็วขึ้น ให้ยกเลิกการเลือกตัวเลือก Rebuild from Bitcode แล้วคลิก Next

    Checks ไม่จำเป็นต้องลดขนาดหรือสร้างแอปใหม่เพื่อเรียกใช้การทดสอบ คุณจึงปิดใช้ตัวเลือกนี้ได้อย่างปลอดภัย

  5. คลิก Export จากนั้นระบุไดเรกทอรีที่ต้องการดาวน์โหลดไฟล์ IPA ของ แอป

อัปโหลด App Bundle

อัปโหลด App Bundle โดยใช้วิธี media.upload

คุณอัปโหลดแอปได้ 2 วิธี ดังนี้

ไบนารีพร้อมข้อมูลเมตา

คุณอาจรวมข้อมูลเมตา เช่น codeReferenceId ซึ่ง ลิงก์การวิเคราะห์กับการคอมมิตที่เฉพาะเจาะจงในที่เก็บโค้ด

ส่งคำขอ POST แบบหลายส่วนพร้อมส่วนหัว X-Goog-Upload-Protocol: multipart โดยส่วนเนื้อหาแรกจะมีข้อมูลเมตาเป็น JSON และส่วนเนื้อหาที่ 2 จะมีการอัปโหลดไบนารี

curl -X POST \
    -H "X-Goog-User-Project: PROJECT_ID" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/checks)" \
    -H "X-Goog-Upload-Protocol: multipart" \
    -F "metadata={\"codeReferenceId\":\"COMMIT_SHA\"}" \
    -F "binary=@BINARY_PATH" \
    "https://checks.googleapis.com/upload/v1alpha/accounts/ACCOUNT_ID/apps/APP_ID/reports:analyzeUpload"

ไบนารีเท่านั้น

ส่งคำขอ POST ปกติพร้อมส่วนหัว X-Goog-Upload-Protocol: raw เพื่ออัปโหลดแอปโดยไม่มีข้อมูลเมตา

curl -X POST \
    -H "X-Goog-User-Project: PROJECT_ID" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/checks)" \
    -H "X-Goog-Upload-Protocol: raw" \
    -H "Content-Type: application/octet-stream" \
    --data-binary @BINARY_PATH \
    "https://checks.googleapis.com/upload/v1alpha/accounts/ACCOUNT_ID/apps/APP_ID/reports:analyzeUpload"

เมื่อแอปอัปโหลดเสร็จแล้ว ระบบจะแสดงผลที่รอดำเนินการ google.longrunning.Operation

{
  "name": "accounts/ACCOUNT_ID/apps/APP_ID/operations/OPERATION_ID"
}

ตรวจสอบสถานะการวิเคราะห์

คุณสามารถตรวจสอบสถานะการวิเคราะห์ได้โดยเรียกใช้วิธี accounts.apps.operations.get

curl -X GET \
    -H "X-Goog-User-Project: PROJECT_ID" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/checks)" \
    "https://checks.googleapis.com/v1alpha/accounts/ACCOUNT_ID/apps/APP_ID/operations/OPERATION_ID"

ระบบจะแสดงผลการตอบกลับต่อไปนี้ตามสถานะ

รอดำเนินการ

{
  "name": "accounts/ACCOUNT_ID/apps/APP_ID/operations/OPERATION_ID"
}

เสร็จสมบูรณ์

{
  "name": "accounts/ACCOUNT_ID/apps/APP_ID/operations/OPERATION_ID",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.checks.report.v1alpha.Report",
    "name": "accounts/ACCOUNT_ID/apps/APP_ID/reports/REPORT_ID",
    "resultsUri": "https://checks.google.com/console/dashboard/REPORT_ID?a=APP_ID"
  }
}

ข้อผิดพลาด

{
  "name": "accounts/ACCOUNT_ID/apps/APP_ID/operations/OPERATION_ID",
  "done": true,
  "error": {
    "code": 500,
    "message": "Deadline exceeded.",
    "status": "INTERNAL",
    "details": [
      ...
    ]
  }
}

ดูการวิเคราะห์

ดูการวิเคราะห์ได้โดยเรียกใช้วิธี accounts.apps.reports.get

curl -X GET \
    -H "X-Goog-User-Project: PROJECT_ID" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/checks)" \
    "https://checks.googleapis.com/v1alpha/accounts/ACCOUNT_ID/apps/APP_ID/reports/REPORT_ID"

โดยค่าเริ่มต้น วิธีนี้จะแสดงผลเฉพาะชื่อทรัพยากรของรายงานและ URL เพื่อดูรายงานในคอนโซล Checks

หากต้องการดูข้อมูลเพิ่มเติม ให้ใส่ฟิลด์มาสก์ในคำขอ เช่น เพิ่มพารามิเตอร์การค้นหาของ URL fields=name,resultsUri,checksเพื่อรวม ฟิลด์ checks

{
  "name": "accounts/ACCOUNT_ID/apps/APP_ID/reports/REPORT_ID",
  "resultsUri": "https://checks.area120.google.com/console/dashboard/REPORT_ID?a=APP_ID",
  "checks": [
    {
      "type": "DATA_MONITORING_NEW_ENDPOINT",
      "severity": "POTENTIAL",
      "state": "FAILED",
      ...
    },
    ...
  ]
}

ขั้นตอนต่อไปคืออะไร

ดูวิธีดึงผลการวิเคราะห์ได้ที่การค้นหารายงาน