認証されたユーザーのすべてのユーザー設定を返します。実習をご覧ください。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/calendar/v3/users/me/settings
パラメータ
| パラメータ名 | 値 | 説明 |
|---|---|---|
| 省略可能なクエリ パラメータ | ||
maxResults |
integer |
1 つの結果ページで返されるエントリの最大数。デフォルトでは、値は 100 エントリです。ページサイズは 250 エントリ以下にする必要があります。省略可能。 |
pageToken |
string |
返す結果ページを指定するトークン。省略可能。 |
syncToken |
string |
前回のリスト リクエストの結果の最後のページで返された nextSyncToken フィールドから取得したトークン。これにより、このリスト リクエストの結果には、それ以降に変更されたエントリのみが含まれます。syncToken の有効期限が切れると、サーバーは 410 GONE レスポンス コードを返します。クライアントはストレージをクリアし、syncToken なしで完全な同期を実行する必要があります。増分同期について詳しくは、こちらをご覧ください。 省略可。デフォルトでは、すべてのエントリが返されます。 |
承認
このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。
| スコープ |
|---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.settings.readonly |
https://www.googleapis.com/auth/calendar.settings |
詳細については、認証と認可のページをご覧ください。
リクエストの本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{
"kind": "calendar#settings",
"etag": etag,
"nextPageToken": string,
"nextSyncToken": string,
"items": [
settings Resource
]
}| プロパティ名 | 値 | 説明 | メモ |
|---|---|---|---|
kind |
string |
コレクションのタイプ(「calendar#settings」)。 |
|
etag |
etag |
コレクションの Etag。 | |
items[] |
list |
ユーザー設定のリスト。 | |
nextPageToken |
string |
この結果の次のページにアクセスするために使用されるトークン。これ以上結果がない場合は省略されます。その場合は nextSyncToken が指定されます。 |
|
nextSyncToken |
string |
この結果が返されてから変更されたエントリのみを取得するために、後で使用されるトークン。追加の結果がある場合は省略されます。その場合、nextPageToken が提供されます。 |
試してみよう:
以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認します。