v1 API への移行

このドキュメントでは、reCAPTCHA Enterprise API の v1beta1 バージョンから v1 バージョンに移行する方法について説明します。

v1beta1 を使用して評価を作成してアノテーションを付ける場合は、reCAPTCHA アカウント ディフェンダーなどの新機能が v1 でのみ使用できるため、v1 を使用することをお勧めします。v1 は、API キーとサービス アカウントの認証の両方をサポートしています。

評価呼び出しを v1beta1 から v1 に移行するには、次のようにします。

  1. 評価を作成するために、呼び出しを置き換えます。

    https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments?key=API_KEY を https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments?key=API_KEY に置き換える

  2. 評価の JSON レスポンスの変更を確認します。

    v1 を使用すると、reasons フィールドと score フィールドはレスポンスで riskAnalysis にカプセル化され、v1beta1 を使用すると、reasons フィールドと score フィールドはレスポンスでカプセル化されません。

    v1

    {
"event":{
  "expectedAction":"EXPECTED_ACTION",
  "hashedAccountId":"ACCOUNT_ID",
  "siteKey":"KEY_ID",
  "token":"TOKEN",
  "userAgent":"(USER-PROVIDED STRING)",
  "userIpAddress":"USER_PROVIDED_IP_ADDRESS"
},
"name":"ASSESSMENT_ID",
 "riskAnalysis":{
  "reasons":[],
  "score":"SCORE
},
"tokenProperties":{
  "action":"USER_INTERACTION",
  "createTime":"TIMESTAMP",
  "hostname":"HOSTNAME",
  "invalidReason":"(ENUM)",
  "valid":(BOOLEAN)
}
}

    v1beta1

    {
"event":{
  "expectedAction":"EXPECTED_ACTION",
  "hashedAccountId":"ACCOUNT_ID",
  "siteKey":"KEY_ID",
  "token":"TOKEN",
  "userAgent":"(USER-PROVIDED STRING)",
  "userIpAddress":"USER_PROVIDED_IP_ADDRESS"
},
"name":"ASSESSMENT_ID",
"reasons":[],
"score":"SCORE",

"tokenProperties":{
  "action":"USER_INTERACTION",
  "createTime":"TIMESTAMP",
  "hostname":"HOSTNAME",
  "invalidReason":"(ENUM)",
  "valid":(BOOLEAN)
}
}

  3. v1 の JSON レスポンスの reasons フィールドと score フィールドを使用するように環境を更新します。

    次のサンプルコードでは、v1 と v1beta1 のレスポンスから使用されるフィールドを示しています。

    v1

    .....
.....
# Get the risk score and the reason(s)
for reason in response.risk_analysis.reasons:
    print(reason)
print(
    "The reCAPTCHA score for this token is: "
    + str(response.risk_analysis.score)
)
....
....

    v1beta1

    .....
.....
# Get the risk score and the reason(s)
for reason in response.reasons:
    print(reason)
print(
    "The reCAPTCHA score for this token is: "
    + str(response.score)
)
....
....

  4. 呼び出しを置き換えて評価にアノテーションを付けます。

    https://recaptchaenterprise.googleapis.com/v1beta1/projects/PROJECT_ID/assessments}:annotate を https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/assessments}:annotate に置き換える

  5. 現在、監査ロギングを使用して create と annotate の API 呼び出しをロギングする場合は、プラットフォーム ロギング（v1 でのみ使用可能）の使用をおすすめします。

次のステップ