Method: projects.locations.connections.gitRepositoryLinks.addPullRequestReviewComment

pull リクエストにレビュー コメント（差分にインライン）を追加します。

HTTP リクエスト

POST https://developerconnect.googleapis.com/v1/{name=projects/*/locations/*/connections/*/gitRepositoryLinks/*}:addPullRequestReviewComment

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。GitRepositoryLink のリソース名（projects/*/locations/*/connections/*/gitRepositoryLinks/* 形式）。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "pullRequestId": string,
  "comment": {
    object (PullRequestReviewComment)
  },
  "commitId": string
}
フィールド
pullRequestId

string

必須。pull リクエストの ID。
comment

object (PullRequestReviewComment)

必須。追加する審査コメント。
commitId

string

省略可。コメントする commit SHA。指定しない場合、デフォルトで pull リクエストの HEAD commit が使用されます。

レスポンスの本文

SCM pull リクエストのレビュー コメント（差分にインライン）を表すメッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "id": string,
  "body": string,
  "path": string,
  "firstLine": integer,
  "lastLine": integer,
  "side": enum (DiffSide),
  "author": string,
  "createTime": string,
  "updateTime": string,
  "commitId": string
}
フィールド
id

string

出力専用。コメントの ID。
body

string

必須。コメントの本文。
path

string

必須。コメントするファイルのパス。
firstLine

integer

省略可。コメント範囲の最初の行（この値を含む）。指定しない場合、コメントは lastLine にのみ適用されます。
lastLine

integer

必須。コメント範囲の最後の行（この値を含む）。firstLine が指定されていない場合、コメントはこの行にのみ適用されます。
side

enum (DiffSide)

省略可。コメントする差分の側。デフォルトは HEAD です。
author

string

出力専用。作成者のユーザー名。
createTime

string (Timestamp format)

出力専用。コメントが作成された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。コメントが更新された日時。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
commitId

string

出力専用。コメントが実際に適用された commit SHA。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • developerconnect.gitRepositoryLinks.addPullRequestReviewComment

詳細については、IAM のドキュメントをご覧ください。

DiffSide

DiffSide は、コメントが差分のどちら側にあるかを表します。

列挙型
DIFF_SIDE_UNSPECIFIED デフォルト値。この値は使用されません。
BASE 変更前の差分（削除または変更された行）。
HEAD 変更後の差分（追加または変更された行）。