如何通过python使用Google sheet API V4在单元格中插入注释

Question

我不知道如何通过 Google Sheet API 在单元格中添加注释： https://developers.google.com/sheets/api/guides/values#writing_multiple_ranges

我阅读了 Google Sheet API 的信息：https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#CellData

我也读过这个问题，但它仍然无法正常工作 Is it possible to use the Google Spreadsheet API to add a comment in a cell?

我不知道如何在值中设置注释。 我需要人帮助~！ 非常感谢。

from __future__ import print_function
import httplib2
import os

from apiclient import discovery
from oauth2client import client
from oauth2client import tools
from oauth2client.file import Storage

try:
    import argparse
    flags = argparse.ArgumentParser(parents=[tools.argparser]).parse_args()
except ImportError:
    flags = None

# If modifying these scopes, delete your previously saved credentials
# at ~/.credentials/sheets.googleapis.com-python-quickstart.json
# Scope type --> https://developers.google.com/sheets/api/guides/authorizing
SCOPES = 'https://www.googleapis.com/auth/spreadsheets'  
CLIENT_SECRET_FILE = 'client_secret.json'        # credentials file name
APPLICATION_NAME = 'auto_update_caspar'


def get_credentials():
"""Gets valid user credentials from storage.

If nothing has been stored, or if the stored credentials are invalid,
the OAuth2 flow is completed to obtain the new credentials.

Returns:
    Credentials, the obtained credential.
"""
home_dir = os.path.expanduser('~')
credential_dir = os.path.join(home_dir, '.credentials')
if not os.path.exists(credential_dir):
    os.makedirs(credential_dir)
credential_path = os.path.join(credential_dir,
                               'auto_update_client_caspar.json')

store = Storage(credential_path)
credentials = store.get()
if not credentials or credentials.invalid:
    flow = client.flow_from_clientsecrets(CLIENT_SECRET_FILE, SCOPES)
    flow.user_agent = APPLICATION_NAME
    if flags:
        credentials = tools.run_flow(flow, store, flags)
    else: # Needed only for compatibility with Python 2.6
        credentials = tools.run(flow, store)
    print('Storing credentials to ' + credential_path)
return credentials

def main():
"""Shows basic usage of the Sheets API.

Creates a Sheets API service object and prints the names and majors of
students in a sample spreadsheet:
https://docs.google.com/spreadsheets/d/1k7OmDU_QUrCPVmsEpWFRCj-4BOu6PcUb7-SQlA7T_8I/edit
"""
credentials = get_credentials()
http = credentials.authorize(httplib2.Http())
discoveryUrl = ('https://sheets.googleapis.com/$discovery/rest?'
                'version=v4')
service = discovery.build('sheets', 'v4', http=http,
                          discoveryServiceUrl=discoveryUrl)

spreadsheetId = '1lEJeSNe5T3rNXEEMjY4D04QkoW-ngOeiFo40_S4H4FI'
rangeName = 'stress_temp!A3'

result = service.spreadsheets().values().get(
    spreadsheetId=spreadsheetId, range=rangeName).execute()
print (result)
values = result.get('values', [])

if not values:
    print('No data found.')
else:
    print('Name, Major:')
    for row in values:
        # Print columns A and E, which correspond to indices 0 and 4.
        print('%s' % row[0])



value_input_option = 'RAW'
range_name = 'stress_temp!A3'
values = [['aa']]
data = [
    {
        'range': range_name,
        'values': values
    },
]`enter code here`
body = {
  'valueInputOption': value_input_option,
  'data': data
}
result = service.spreadsheets().values().batchUpdate(
    spreadsheetId=spreadsheetId, body=body).execute()



if __name__ == '__main__':
main()

Answer 1

在 Python 中，我使用了这段代码，它可以工作。

from googleapiclient.discovery import build
from google.oauth2 import service_account

SCOPES = ["https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file",
                  "https://www.googleapis.com/auth/spreadsheets"]
SERVICE_ACCOUNT_FILE = 'credentials.json'

credentials = service_account.Credentials.from_service_account_file(SERVICE_ACCOUNT_FILE, scopes=SCOPES)
service = build('sheets', 'v4', credentials=credentials)

spreadsheetId = "O188999ITC"
sheetid_src = "123a"
notes = {
            "updateCells": {
                "range": {
                    "sheetId": sheetid_src,
                    "startRowIndex": 1,
                    "endRowIndex: 1,
                    "startColumnIndex": 1,
                    "endColumnIndex": 1
                },
                "rows": [
                    {
                        "values": [
                            {
                                "note": "my note"
                            }
                        ]
                    }
                ],
                "fields": "note"
            }
        }
body = {"requests":[notes]}
result = service.spreadsheets().values().batchUpdate(
    spreadsheetId=spreadsheetId, body=body).execute()

Note 在 API 中与 cellData 可用，因此您必须使用关键字“Notes”更新不同单元格的值。

您可以在此处找到更多信息： https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#celldata

Answer 2

我没有看到任何关于您的问题的文档。您可以参考此SO thread，但它讨论了如何使用getNote() 获取注释。在您的情况下，您需要使用 Google Apps 脚本并使用以下方法：

• setNote(note) - 将注释设置为给定值。
• setNotes(notes) - 设置一个矩形的音符网格（必须匹配此范围的尺寸）。

您也可以查看此related reported issue。希望这会有所帮助！