Przesyłanie aplikacji do analizy

Interfejs Checks API może analizować aplikacje na Androida i iOS przed ich opublikowaniem, dzięki czemu możesz sprawdzić, jakie dane zbiera i udostępnia Twoja aplikacja oraz czy nie występują w niej potencjalne problemy ze zgodnością zanim udostępnisz ją publicznie.

To krótkie wprowadzenie pokazuje, jak przesłać aplikację za pomocą gcloud CLI i polecenia cURL.

Wymagania wstępne

Zanim zaczniesz, upewnij się, że możesz wysyłać autoryzowane żądania zgodnie z naszym przewodnikiem po autoryzacji.

Przygotowanie pakietu aplikacji

Android

  1. Wygeneruj plik APK lub pakiet aplikacji na Androida.

    Instrukcje znajdziesz w dokumentacji Androida w sekcji Tworzenie i uruchamianie aplikacji.

iOS

  1. W Xcode wybierz profil zaopatrzenia dla docelowej aplikacji.

  2. W wyświetlonym menu kliknij Product (Produkt) > Archive (Archiwum). Wybierz najnowsze archiwum, a następnie kliknij Distribute App (Rozpowszechnij aplikację).

  3. W wyświetlonym oknie kliknij Development (Tworzenie) > Next (Dalej).

  4. (Opcjonalnie) Aby przyspieszyć tworzenie, odznacz opcję Rebuild from Bitcode (Odbuduj z Bitcode), a następnie kliknij Next (Dalej).

    Usługa Checks nie wymaga zmniejszania rozmiaru ani ponownego tworzenia aplikacji, aby przeprowadzić test, więc możesz bezpiecznie wyłączyć tę opcję.

  5. Kliknij Export (Eksportuj), a następnie określ katalog, w którym chcesz pobrać plik IPA aplikacji.

Przesyłanie pakietu aplikacji

Prześlij pakiet aplikacji za pomocą metody media.upload.

Aplikację możesz przesłać na 2 sposoby:

Plik binarny z metadanymi

Możesz uwzględnić metadane, takie jak codeReferenceId, które łączą analizę z konkretnym zatwierdzeniem w repozytorium kodu.

Wyślij żądanie POST z wieloma częściami i nagłówkiem X-Goog-Upload-Protocol: multipart, gdzie pierwsza część treści zawiera metadane w formacie JSON, a druga – plik binarny:

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"

Tylko plik binarny

Aby przesłać aplikację bez metadanych, wyślij zwykłe żądanie POST z nagłówkiem 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"

Po zakończeniu przesyłania aplikacji zwracana jest oczekująca google.longrunning.Operation:

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

Sprawdzanie stanu analizy

Stan analizy możesz sprawdzić, wywołując metodę 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"

W zależności od stanu zwracana jest jedna z tych odpowiedzi:

Oczekuje

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

Zakończone

{
  "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"
  }
}

Błąd

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

Wyświetlanie analizy

Aby wyświetlić analizę, wywołaj metodę 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"

Domyślnie zwraca ona tylko nazwę zasobu raportu i adres URL, pod którym można wyświetlić raport w konsoli Checks.

Aby wyświetlić więcej danych, dodaj maskę pól w żądaniu. Na przykład dodaj parametr zapytania URL fields=name,resultsUri,checks, aby uwzględnić pole 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",
      ...
    },
    ...
  ]
}

Co dalej?

Aby dowiedzieć się, jak pobrać wyniki analizy, zapoznaj się z artykułem Wykonywanie zapytań o raporty.