名前付き範囲と保護されている範囲

Google Sheets API では、名前付きまたは保護されたデータを作成、変更、削除できる あります。このページの例では、一般的な Sheets API によるスプレッドシート オペレーション。

これらの例は、HTTP リクエストという形式で示されています。これは、 ニュートラルです。異なる言語のバッチ アップデートを実装する方法については、 Google API クライアント ライブラリについては、 スプレッドシート。

これらの例では、プレースホルダ SPREADSHEET_ID と SHEET_ID は、 は、これらの ID を指定する場所を示しています。そのスプレッドシートの ID を入力します。取得できるもの: シート ID spreadsheets.get メソッドを使用します。「 範囲は A1 表記で指定します。「 Sheet1!A1:D5 です。

また、プレースホルダ NAMED_RANGE_ID と PROTECTED_RANGE_ID も、 名前付き範囲と保護されている範囲の ID を指定します。namedRangeId と protectedRangeId は、ファイルの更新や削除をリクエストするときに使用されます。 関連付けられますSheets API へのレスポンスで ID が返されます。 名前付き範囲または保護されている範囲を作成するリクエストです。既存の VM の ID を 範囲を spreadsheets.get メソッド（ Spreadsheet レスポンスの本文です

名前付き範囲または保護されている範囲を追加

次の spreadsheets.batchUpdate コードサンプルは、2 つのリクエスト オブジェクトの使用方法を示しています。1 つ目は、 AddNamedRangeRequest 範囲 A1:E3 に「Counts」という名前を割り当てます。2 つ目は、 AddProtectedRangeRequest 範囲 A4:E4 に警告レベルの保護を適用します。このレベルの保護 範囲内のセルの編集は引き続き許可されますが、編集前に警告メッセージが表示されます。 変更を行います。

これらのリクエストでは、 AddNamedRangeResponse および AddProtectedRangeResponse, 範囲 ID とプロパティが含まれます。

リクエスト プロトコルを以下に示します。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "addNamedRange": {
        "namedRange": {
          "name": "Counts",
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 0,
            "endRowIndex": 3,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
        }
      }
    },
    {
      "addProtectedRange": {
        "protectedRange": {
          "range": {
            "sheetId": SHEET_ID,
            "startRowIndex": 3,
            "endRowIndex": 4,
            "startColumnIndex": 0,
            "endColumnIndex": 5,
          },
          "description": "Protecting total row",
          "warningOnly": true
        }
      }
    }
  ]
}

名前付き範囲または保護されている範囲を削除する

次の spreadsheets.batchUpdate コードサンプルは、2 つのリクエスト オブジェクトの使用方法を示しています。1 つ目は、 DeleteNamedRangeRequest 既存の名前付き範囲を削除するには、NAMED_RANGE_ID 確認できます。2 つ目は、 DeleteProtectedRangeRequest PROTECTED_RANGE_ID を使用して既存の範囲の保護を削除する データを取得できます。

リクエスト プロトコルを以下に示します。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "deleteNamedRange": {
          "namedRangeId": "NAMED_RANGE_ID",
      }
    },
    {
      "deleteProtectedRange": {
        "protectedRangeId": PROTECTED_RANGE_ID,
      }
    }
  ]
}

名前付き範囲または保護されている範囲を更新する

次の spreadsheets.batchUpdate コードサンプルは、2 つのリクエスト オブジェクトの使用方法を示しています。1 つ目は、 UpdateNamedRangeRequest NAMED_RANGE_ID を使用して、既存の名前付き範囲の名前を「InitialCounts」に更新します。 データを取得できます。2 つ目は、 UpdateProtectedRangeRequest 既存の保護されている範囲を更新して、同じ名前付き範囲を あります。「 Editors メソッド リストされたユーザーのみがこれらのセルを編集できます。このリクエストでは NAMED_RANGE_ID を使用します。 以前の API 呼び出しの PROTECTED_RANGE_ID。

リクエスト プロトコルを以下に示します。

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "updateNamedRange": {
        "namedRange": {
          "namedRangeId": NAMED_RANGE_ID,
          "name": "InitialCounts",
        },
        "fields": "name",
      }
    },
    {
      "updateProtectedRange": {
        "protectedRange": {
          "protectedRangeId": PROTECTED_RANGE_ID,
          "namedRangeId": NAMED_RANGE_ID,
          "warningOnly": false,
          "editors": {
            "users": [
              "[e-mail]",
              "[e-mail]"
            ]
          }
        },
        "fields": "namedRangeId,warningOnly,editors"
      }
    }
  ]
}