KAC Google Gmail
スレッド、メッセージ、ラベルなどの Gmail メールボックス データを表示および管理できます。
リリース予定：済
最新バージョン：1.0
最新バージョンリリース日：2024/11/01
カスタムコネクタJSONダウンロードURL：https://drive.google.com/uc?export=download&id=11cGy1pmMr7d8thMHIeBsg0UY7Ls9L9Om
Embedded Files
仕様・制限事項
KAC のカウントは getToken アクションの1リクエストごとに1回カウントアップされます。
詳細な仕様については公式ドキュメントを参照してください。https://developers.google.com/gmail/api/reference/rest
サインインに必要な情報
Google アカウントによるサインインと認証
getToken
getToken
アクセストークンを取得します。
パラメータ
なし
レスポンス
access_token: アクセストークン
payedCheck: カウント情報
count: 総カウント数
maxCount: 当月の限度カウント数
count_カスタムコネクタ名: コネクタの総カウント数
mSec: 総実行時間
maxMSec: 当月の限度実行時間
gmail_users_getProfile
gmail_users_getProfile
現在のユーザーの Gmail プロフィールを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「 Method: users.getProfile」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users/getProfile
gmail_users_watch
gmail_users_watch
指定されたユーザーのメールボックスでプッシュ通知監視を設定または更新します。
パラメータ
labelIds: 通知を制限する label_id のリスト。デフォルトでは、指定されていない場合、すべての変更がプッシュアウトされます。指定した場合、プッシュ通知の生成にどのラベルが必要かが決まります。
labelFilterAction: `labelIds list` のフィルタリング動作が指定されました。このフィールドは、場合によっては誤った動作を引き起こす可能性があるため、非推奨になりました。代わりに「label_filter_behavior」を使用してください。
labelFilterBehavior: `labelIds list` のフィルタリング動作が指定されました。このフィールドは「label_filter_action」を置き換えます。設定されている場合、「label_filter_action」は無視されます。
topicName: イベントを公開する完全修飾 Google Cloud Pub/Sub API トピック名。このトピック名は Cloud Pub/Sub にすでに存在している必要があり、Gmail にそのトピックに対する「公開」権限を付与している必要があります。たとえば、「projects/my-project-identifier/topics/my-topic-name」（Cloud Pub/Sub「v1」トピック命名形式を使用）。 「my-project-identifier」部分は、Google 開発者プロジェクト ID (この監視リクエストを実行するもの) と正確に一致する必要があることに注意してください。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.watch」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users/watch
gmail_users_stop
gmail_users_stop
指定されたユーザーのメールボックスのプッシュ通知の受信を停止します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.stop」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users/stop
gmail_users_drafts_delete
gmail_users_drafts_delete
指定された下書きを即座に完全に削除します。単にゴミ箱にするだけではありません。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 削除するドラフトの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/delete
gmail_users_drafts_create
gmail_users_drafts_create
ファイルの Upload はサポートしておりません。「DRAFT」ラベルが付いた新しいドラフトを作成します。
パラメータ
id: ドラフトの不変 ID。
message.id: メッセージの不変 ID。
message.threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
message.labelIds: このメッセージに適用されるラベルの ID のリスト。
message.snippet: メッセージテキストの短い部分。
message.historyId: このメッセージを変更した最後の履歴レコードの ID。
message.internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
message.payload.partId: メッセージ部分の不変の ID。
message.payload.mimeType: メッセージ部分の MIME タイプ。
message.payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
message.payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
message.payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
message.payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
message.payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
message.sizeEstimate: メッセージの推定サイズ (バイト単位)。
message.raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create
gmail_users_drafts_get
gmail_users_drafts_get
指定されたドラフトを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 取得するドラフトの ID。
format: ドラフトを返す形式。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/get
gmail_users_drafts_list
gmail_users_drafts_list
ユーザーのメールボックスの下書きを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
maxResults: 返されるドラフトの最大数。このフィールドのデフォルトは 100 です。このフィールドに許可される最大値は 500 です。
pageToken: リスト内の結果の特定のページを取得するためのページ トークン。
q: 指定されたクエリに一致する下書きメッセージのみを返します。 Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、「from:someuser@example.com rfc822msgid: is:unread」`。
includeSpamTrash: 「SPAM」と「TRASH」からの下書きを結果に含めます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/get
gmail_users_drafts_send
gmail_users_drafts_send
ファイルの Upload はサポートしておりません。指定された既存の下書きを「To」、「Cc」、および「Bcc」ヘッダーで受信者に送信します。
パラメータ
id: ドラフトの不変 ID。
message.id: メッセージの不変 ID。
message.threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
message.labelIds: このメッセージに適用されるラベルの ID のリスト。
message.snippet: メッセージテキストの短い部分。
message.historyId: このメッセージを変更した最後の履歴レコードの ID。
message.internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
message.payload.partId: メッセージ部分の不変の ID。
message.payload.mimeType: メッセージ部分の MIME タイプ。
message.payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
message.payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
message.payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
message.payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
message.payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
message.sizeEstimate: メッセージの推定サイズ (バイト単位)。
message.raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.send」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/send
gmail_users_drafts_update
gmail_users_drafts_update
ファイルの Upload はサポートしておりません。下書きの内容を置き換えます。
パラメータ
message.id: メッセージの不変 ID。
message.threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
message.labelIds: このメッセージに適用されるラベルの ID のリスト。
message.snippet: メッセージテキストの短い部分。
message.historyId: このメッセージを変更した最後の履歴レコードの ID。
message.internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
message.payload.partId: メッセージ部分の不変の ID。
message.payload.mimeType: メッセージ部分の MIME タイプ。
message.payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
message.payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
message.payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
message.payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
message.payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
message.sizeEstimate: メッセージの推定サイズ (バイト単位)。
message.raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 更新するドラフトの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.drafts.update」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/update
gmail_users_history_list
gmail_users_history_list
指定されたメールボックスに対するすべての変更履歴を一覧表示します。履歴結果は時系列順に返されます (`historyId` が増加する)。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
maxResults: 返される履歴レコードの最大数。このフィールドのデフォルトは 100 です。このフィールドに許可される最大値は 500 です。
pageToken: リスト内の結果の特定のページを取得するためのページ トークン。
startHistoryId: 必須。指定された `startHistoryId` 以降の履歴レコードを返します。指定された `startHistoryId` は、メッセージ、スレッド、または前の `list` 応答の `historyId` から取得する必要があります。履歴 ID は時系列に増加しますが、有効な ID 間にはランダムなギャップがあり、連続していません。無効または期限切れの `startHistoryId` を指定すると、通常は `HTTP 404` エラー コードが返されます。 「historyId」は通常、少なくとも 1 週間有効ですが、まれに数時間しか有効でない場合もあります。 「HTTP 404」エラー応答を受け取った場合、アプリケーションは完全同期を実行する必要があります。応答で「nextPage
labelId: ID と一致するラベルを持つメッセージのみを返します。
historyTypes: 関数によって返される履歴タイプ
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.history.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.history/list
gmail_users_messages_trash
gmail_users_messages_trash
指定されたメッセージをゴミ箱に移動します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: ゴミ箱に入れるメッセージの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.trash」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/trash
gmail_users_messages_untrash
gmail_users_messages_untrash
指定されたメッセージをゴミ箱から削除します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: ゴミ箱から削除するメッセージの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.trash」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/trash
gmail_users_messages_delete
gmail_users_messages_delete
指定されたメッセージを即時かつ永久に削除します。この操作は元に戻すことができません。代わりに `messages.trash` を使用してください。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 削除するメッセージのID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/delete
gmail_users_messages_batchDelete
gmail_users_messages_batchDelete
メッセージ ID に基づいて多数のメッセージを削除します。メッセージがまだ削除されていない、あるいはまったく存在していなかったという保証はありません。
パラメータ
ids: 削除するメッセージの ID。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.batchDelete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/batchDelete
gmail_users_messages_import
gmail_users_messages_import
ファイルの Upload はサポートしておりません。SMTP 経由の受信と同様の標準的な電子メール配信スキャンと分類を使用して、メッセージをこのユーザーのメールボックスのみにインポートします。この方法は SPF チェックを実行しないため、ドメイン スプーフィングを実行しようとするスパム メッセージなど、一部のスパム メッセージに対しては機能しない可能性があります。このメソッドはメッセージを送信しません。
パラメータ
id: メッセージの不変 ID。
threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
labelIds: このメッセージに適用されるラベルの ID のリスト。
snippet: メッセージテキストの短い部分。
historyId: このメッセージを変更した最後の履歴レコードの ID。
internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
payload.partId: メッセージ部分の不変の ID。
payload.mimeType: メッセージ部分の MIME タイプ。
payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
sizeEstimate: メッセージの推定サイズ (バイト単位)。
raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
internalDateSource: Gmail のメッセージの内部日付のソース。
neverMarkSpam: Gmail のスパム分類子の決定を無視し、メールボックス内でこのメールを決してスパムとしてマークしないでください。
processForCalendar: メール内のカレンダーの招待を処理し、抽出された会議をこのユーザーの Google カレンダーに追加します。
deleted: メールを完全に削除済み (ゴミ箱ではない) としてマークし、Google Vault 内で Vault 管理者にのみ表示されるようにします。 Google Workspace アカウントにのみ使用されます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.import」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/import
gmail_users_messages_insert
gmail_users_messages_insert
ファイルの Upload はサポートしておりません。「IMAP APPEND」と同様に、ほとんどのスキャンと分類をバイパスして、このユーザーのメールボックスのみにメッセージを直接挿入します。メッセージは送信しません。
パラメータ
id: メッセージの不変 ID。
threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
labelIds: このメッセージに適用されるラベルの ID のリスト。
snippet: メッセージテキストの短い部分。
historyId: このメッセージを変更した最後の履歴レコードの ID。
internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
payload.partId: メッセージ部分の不変の ID。
payload.mimeType: メッセージ部分の MIME タイプ。
payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
sizeEstimate: メッセージの推定サイズ (バイト単位)。
raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
internalDateSource: Gmail のメッセージの内部日付のソース。
deleted: メールを完全に削除済み (ゴミ箱ではない) としてマークし、Google Vault 内で Vault 管理者にのみ表示されるようにします。 Google Workspace アカウントにのみ使用されます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.insert」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/insert
gmail_users_messages_get
gmail_users_messages_get
指定されたメッセージを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 取得するメッセージの ID。この ID は通常、`messages.list` を使用して取得されます。 ID は、メッセージの挿入 (`messages.insert`) またはインポート (`messages.import`) の結果にも含まれます。
format: メッセージを返す形式。
metadataHeaders: 指定され、形式が「METADATA」の場合、指定されたヘッダーのみが含まれます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get
gmail_users_messages_send
gmail_users_messages_send
ファイルの Upload はサポートしておりません。指定されたメッセージを「To」、「Cc」、および「Bcc」ヘッダーで受信者に送信します。使用例については、[メールの送信](https://developers.google.com/gmail/api/guides/sending)をご覧ください。
パラメータ
id: メッセージの不変 ID。
threadId: メッセージが属するスレッドの ID。メッセージまたは下書きをスレッドに追加するには、次の基準を満たす必要があります。 1. 要求された `threadId` は、リクエストで指定する `Message` または `Draft.Message` で指定する必要があります。 2. 「References」ヘッダーと「In-Reply-To」ヘッダーは、[RFC 2822](https://tools.ietf.org/html/rfc2822) 標準に従って設定する必要があります。 3. 「Subject」ヘッダーは一致する必要があります。
labelIds: このメッセージに適用されるラベルの ID のリスト。
snippet: メッセージテキストの短い部分。
historyId: このメッセージを変更した最後の履歴レコードの ID。
internalDate: 内部メッセージ作成タイムスタンプ (エポックミリ秒)。これにより、受信ボックス内の順序が決まります。通常の SMTP 受信電子メールの場合、これはメッセージが最初に Google によって受け入れられた時刻を表し、「Date」ヘッダーよりも信頼性が高くなります。ただし、API で移行されたメールの場合、クライアントは「Date」ヘッダーに基づいてメールを構成できます。
payload.partId: メッセージ部分の不変の ID。
payload.mimeType: メッセージ部分の MIME タイプ。
payload.filename: 添付ファイルのファイル名。このメッセージ部分が添付ファイルを表す場合にのみ存在します。
payload.headers: このメッセージ部分のヘッダーのリスト。メッセージ ペイロード全体を表すトップレベルのメッセージ部分には、「To」、「From」、「Subject」などの標準 RFC 2822 電子メール ヘッダーが含まれます。
name: 「:」区切り文字の前のヘッダーの名前。たとえば、「宛」です。
value: `:` 区切り文字の後のヘッダーの値。たとえば、「someuser@example.com」です。
payload.body.attachmentId: 存在する場合、別の `messages.attachments.get` リクエストで取得できる外部添付ファイルの ID が含まれます。存在しない場合、メッセージ部分の本文の内容全体がデータ フィールドに含まれます。
payload.body.size: メッセージ部分データのバイト数 (エンコーディングにかかわらず)。
payload.body.data: MIME メッセージ部分の本文データ (base64url エンコード文字列)。メッセージ本文がない MIME コンテナ タイプの場合、または本文データが別の添付ファイルとして送信される場合は、空になる可能性があります。添付ファイル ID は、本文データが別の添付ファイルに含まれている場合に存在します。
sizeEstimate: メッセージの推定サイズ (バイト単位)。
raw: RFC 2822 形式で Base64URL エンコードされた文字列の電子メール メッセージ全体。 `format=RAW` パラメータが指定されている場合、`messages.get` および `drafts.get` 応答で返されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.send」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send
gmail_users_messages_list
gmail_users_messages_list
ユーザーのメールボックス内のメッセージを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
maxResults: 返されるメッセージの最大数。このフィールドのデフォルトは 100 です。このフィールドに許可される最大値は 500 です。
pageToken: リスト内の結果の特定のページを取得するためのページ トークン。
q: 指定されたクエリに一致するメッセージのみを返します。 Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、「from:someuser@example.com rfc822msgid: is:unread」`。 gmail.metadata スコープを使用して API にアクセスする場合、パラメーターは使用できません。
labelIds: 指定されたラベル ID のすべてに一致するラベルを持つメッセージのみを返します。スレッド内のメッセージには、同じスレッド内の他のメッセージにはないラベルが付いている場合があります。詳細については、[メッセージとスレッドのラベルを管理する](https://developers.google.com/gmail/api/guides/labels#manage_labels_on_messages_threads) をご覧ください。
includeSpamTrash: 「SPAM」と「TRASH」からのメッセージを結果に含めます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list
gmail_users_messages_modify
gmail_users_messages_modify
指定されたメッセージのラベルを変更します。
パラメータ
addLabelIds: このメッセージに追加するラベルの ID のリスト。更新ごとに最大 100 個のラベルを追加できます。
removeLabelIds: このメッセージから削除するラベルのリスト ID。更新ごとに最大 100 個のラベルを削除できます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 変更するメッセージの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.modify」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify
gmail_users_messages_batchModify
gmail_users_messages_batchModify
指定されたメッセージのラベルを変更します。
パラメータ
ids: 変更するメッセージの ID。リクエストあたりの ID の制限は 1000 です。
addLabelIds: メッセージに追加するラベル ID のリスト。
removeLabelIds: メッセージから削除するラベル ID のリスト。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.batchModify」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages/batchModify
gmail_users_messages_attachments_g
gmail_users_messages_attachments_g
指定されたメッセージの添付ファイルを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
messageId: 添付ファイルを含むメッセージの ID。
id: 添付ファイルの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.mesages.attachments.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.messages.attachments/get
gmail_users_labels_create
gmail_users_labels_create
新しいラベルを作成します。
パラメータ
id: ラベルの不変の ID。
name: ラベルの表示名。
messageListVisibility: Gmail ウェブ インターフェースのメッセージ リストにおける、このラベルが付いたメッセージの表示設定。
labelListVisibility: Gmail Web インターフェースのラベル リストでのラベルの表示設定。
type: ラベルの所有者のタイプ。ユーザー ラベルはユーザーによって作成され、ユーザーによって変更および削除でき、任意のメッセージまたはスレッドに適用できます。システム ラベルは内部で作成され、追加、変更、削除することはできません。状況によっては、システム ラベルをメッセージやスレッドに適用したり削除したりできる場合がありますが、これは保証されません。たとえば、ユーザーはメッセージやスレッドに「INBOX」ラベルや「UNREAD」ラベルを適用したり削除したりできますが、「DRAFTS」ラベルや「SENT」ラベルをメッセージやスレッドに適用したり削除したりすることはできません。
messagesTotal: ラベルが付いたメッセージの総数。
messagesUnread: ラベルが付いた未読メッセージの数。
threadsTotal: ラベルが付いたスレッドの総数。
threadsUnread: ラベルが付いた未読のスレッドの数。
color.textColor: ラベルのテキストの色。16 進文字列として表されます。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a4c2f4, #d0bc
color.backgroundColor: 16 進文字列 #RRGGBB (例 #000000) として表される背景色。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/create
gmail_users_labels_delete
gmail_users_labels_delete
指定されたラベルを即時かつ永久に削除し、そのラベルが適用されているメッセージおよびスレッドから削除します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 削除するラベルのID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/delete
gmail_users_labels_get
gmail_users_labels_get
指定されたラベルを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 取得するラベルの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/get
gmail_users_labels_list
gmail_users_labels_list
ユーザーのメールボックス内のすべてのラベルを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list
gmail_users_labels_update
gmail_users_labels_update
指定されたラベルを更新します。
パラメータ
name: ラベルの表示名。
messageListVisibility: Gmail ウェブ インターフェースのメッセージ リストにおける、このラベルが付いたメッセージの表示設定。
labelListVisibility: Gmail Web インターフェースのラベル リストでのラベルの表示設定。
type: ラベルの所有者のタイプ。ユーザー ラベルはユーザーによって作成され、ユーザーによって変更および削除でき、任意のメッセージまたはスレッドに適用できます。システム ラベルは内部で作成され、追加、変更、削除することはできません。状況によっては、システム ラベルをメッセージやスレッドに適用したり削除したりできる場合がありますが、これは保証されません。たとえば、ユーザーはメッセージやスレッドに「INBOX」ラベルや「UNREAD」ラベルを適用したり削除したりできますが、「DRAFTS」ラベルや「SENT」ラベルをメッセージやスレッドに適用したり削除したりすることはできません。
messagesTotal: ラベルが付いたメッセージの総数。
messagesUnread: ラベルが付いた未読メッセージの数。
threadsTotal: ラベルが付いたスレッドの総数。
threadsUnread: ラベルが付いた未読のスレッドの数。
color.textColor: ラベルのテキストの色。16 進文字列として表されます。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a4c2f4, #d0bc
color.backgroundColor: 16 進文字列 #RRGGBB (例 #000000) として表される背景色。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 更新するラベルの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.update」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/update
gmail_users_labels_patch
gmail_users_labels_patch
指定されたラベルにパッチを適用します。
パラメータ
name: ラベルの表示名。
messageListVisibility: Gmail ウェブ インターフェースのメッセージ リストにおける、このラベルが付いたメッセージの表示設定。
labelListVisibility: Gmail Web インターフェースのラベル リストでのラベルの表示設定。
type: ラベルの所有者のタイプ。ユーザー ラベルはユーザーによって作成され、ユーザーによって変更および削除でき、任意のメッセージまたはスレッドに適用できます。システム ラベルは内部で作成され、追加、変更、削除することはできません。状況によっては、システム ラベルをメッセージやスレッドに適用したり削除したりできる場合がありますが、これは保証されません。たとえば、ユーザーはメッセージやスレッドに「INBOX」ラベルや「UNREAD」ラベルを適用したり削除したりできますが、「DRAFTS」ラベルや「SENT」ラベルをメッセージやスレッドに適用したり削除したりすることはできません。
messagesTotal: ラベルが付いたメッセージの総数。
messagesUnread: ラベルが付いた未読メッセージの数。
threadsTotal: ラベルが付いたスレッドの総数。
threadsUnread: ラベルが付いた未読のスレッドの数。
color.textColor: ラベルのテキストの色。16 進文字列として表されます。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a4c2f4, #d0bc
color.backgroundColor: 16 進文字列 #RRGGBB (例 #000000) として表される背景色。このフィールドはラベルの色を設定するために必要です。次の事前定義されたカラー値のセットのみが許可されます: \#000000、#434343、#666666、#999999、#cccccc、#efefef、#f3f3f3、#ffffff、\#fb4c2f、#ffad47、#fad165、#16a766、# 43d692, #4a86e8, #a479e2, #f691b3, \#f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, \#efa093, #ffd6a2, #fce8b3, #89d3b2, # a0eac9, #a
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 更新するラベルの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.labels.patch」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.labels/patch
gmail_users_threads_trash
gmail_users_threads_trash
指定したスレッドをゴミ箱に移動します。スレッドに属するメッセージもすべてゴミ箱に移動されます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: ゴミ箱に入れるスレッドの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.trash」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/trash
gmail_users_threads_untrash
gmail_users_threads_untrash
指定されたスレッドをゴミ箱から削除します。スレッドに属するメッセージもゴミ箱から削除されます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: ゴミ箱から削除するスレッドの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.untrash」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/untrash
gmail_users_threads_delete
gmail_users_threads_delete
指定されたスレッドを即時かつ永久に削除します。スレッドに属するメッセージもすべて削除されます。この操作は元に戻すことができません。代わりに「threads.trash」を使用してください。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 削除するスレッドの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/delete
gmail_users_threads_get
gmail_users_threads_get
指定されたスレッドを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 取得するスレッドの ID。
format: メッセージを返す形式。
metadataHeaders: 指定され、形式が METADATA の場合、指定されたヘッダーのみが含まれます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/get
gmail_users_threads_list
gmail_users_threads_list
ユーザーのメールボックス内のスレッドを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
maxResults: 返されるスレッドの最大数。このフィールドのデフォルトは 100 です。このフィールドに許可される最大値は 500 です。
pageToken: リスト内の結果の特定のページを取得するためのページ トークン。
q: 指定されたクエリに一致するスレッドのみを返します。 Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、「from:someuser@example.com rfc822msgid: is:unread」`。 gmail.metadata スコープを使用して API にアクセスする場合、パラメーターは使用できません。
labelIds: 指定されたラベル ID のすべてに一致するラベルを持つスレッドのみを返します。
includeSpamTrash: 「SPAM」と「TRASH」からのスレッドを結果に含めます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list
gmail_users_threads_modify
gmail_users_threads_modify
スレッドに適用されるラベルを変更します。これはスレッド内のすべてのメッセージに適用されます。
パラメータ
addLabelIds: このスレッドに追加するラベルの ID のリスト。更新ごとに最大 100 個のラベルを追加できます。
removeLabelIds: このスレッドから削除するラベルの ID のリスト。更新ごとに最大 100 個のラベルを削除できます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 変更するスレッドの ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.threads.modify」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify
gmail_users_settings_getImap
gmail_users_settings_getImap
IMAP設定を取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.getImap」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getImap
gmail_users_settings_updateImap
gmail_users_settings_updateImap
IMAP設定を更新します。
パラメータ
enabled: アカウントに対して IMAP が有効かどうか。
autoExpunge: この値が true の場合、IMAP でメッセージが削除済みとしてマークされると、Gmail はメッセージをすぐに削除します。それ以外の場合、Gmail はクライアントからの更新を待ってから、削除済みとしてマークされたメッセージを消去します。
expungeBehavior: メッセージが削除済みとしてマークされ、最後に表示されている IMAP フォルダーから消去されたときに、メッセージに対して実行されるアクション。
maxFolderSize: IMAP フォルダーに含めることができるメッセージの数に対するオプションの制限。有効な値は 0、1000、2000、5000、または 10000 です。値 0 は、制限がないことを意味すると解釈されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.updateImap」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateImap
gmail_users_settings_getPop
gmail_users_settings_getPop
POP設定を取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.getPop」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getPop
gmail_users_settings_updatePop
gmail_users_settings_updatePop
POP設定を更新します。
パラメータ
accessWindow: POP 経由でアクセスできるメッセージの範囲。
disposition: POP 経由でメッセージが取得された後に、メッセージに対して実行されるアクション。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.updatePop」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updatePop
gmail_users_settings_getVacation
gmail_users_settings_getVacation
休暇応答者の設定を取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.getVacation」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getVacation
gmail_users_settings_updateVacation
gmail_users_settings_updateVacation
休暇応答者の設定を更新します。
パラメータ
enableAutoReply: Gmail がメッセージに自動的に返信するかどうかを制御するフラグ。
responseSubject: 休暇中の返信の件名の前に追加するオプションのテキスト。自動返信を有効にするには、応答の件名または本文のいずれかが空でない必要があります。
responseBodyPlainText: プレーンテキスト形式の応答本文。 「response_body_plain_text」と「response_body_html」の両方が指定されている場合は、「response_body_html」が使用されます。
responseBodyHtml: HTML 形式の応答本文。 Gmail は HTML を保存する前にサニタイズします。 「response_body_plain_text」と「response_body_html」の両方が指定されている場合は、「response_body_html」が使用されます。
restrictToContacts: ユーザーの連絡先リストにない受信者に応答を送信するかどうかを決定するフラグ。
restrictToDomain: ユーザーのドメイン外の受信者に応答を送信するかどうかを決定するフラグ。この機能は、Google Workspace ユーザーのみが利用できます。
startTime: 自動応答を送信するためのオプションの開始時間 (エポックミリ秒)。これを指定すると、Gmail は開始時刻以降に受信したメッセージにのみ自動的に返信します。 `startTime` と `endTime` の両方を指定する場合、`startTime` は `endTime` より前に置く必要があります。
endTime: 自動応答の送信のオプションの終了時刻 (エポックミリ秒)。これを指定すると、Gmail は終了時刻までに受信したメッセージにのみ自動的に返信します。 `startTime` と `endTime` の両方を指定する場合、`startTime` は `endTime` より前に置く必要があります。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.updateVacation」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateVacation
gmail_users_settings_getLanguage
gmail_users_settings_getLanguage
言語設定を取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.getLanguage」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/getLanguage
gmail_users_settings_updateLanguage
gmail_users_settings_updateLanguage
言語設定を更新します。成功した場合、返されるオブジェクトにはユーザー用に保存された `displayLanguage` が含まれますが、これはリクエストに渡された値とは異なる場合があります。これは、要求された「displayLanguage」が Gmail で直接サポートされていない可能性がありますが、類似したバリアントがあり、代わりにそのバリアントが選択されて保存される可能性があるためです。
パラメータ
displayLanguage: Gmail を表示する言語。RFC 3066 言語タグとしてフォーマットされます（たとえば、イギリス英語、フランス語、日本語をそれぞれ表す「en-GB」、「fr」、または「ja」）。 Gmail でサポートされる言語セットは時間の経過とともに進化するため、言語設定のヘルプ記事で説明されているように、利用可能なすべてのオプションについては、Gmail 設定の [言語] ドロップダウンを参照してください。サンプル値の表は、『言語設定の管理』ガイドにも記載されています。すべての Gmail クライアントが同じ言語セットを表示できるわけではありません。ユーザーの表示言語が特定のクライアントで使用できない場合、そのクライアントはサポートされている最も近い言語 (または合理的なデフォルト) で表示するこ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.updateLanguage」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateLanguage
gmail_users_settings_updateAutoForwar
gmail_users_settings_updateAutoForwar
指定されたアカウントの自動転送設定を更新します。自動転送が有効な場合は、検証済みの転送アドレスを指定する必要があります。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
enabled: すべての受信メールを別のアドレスに自動的に転送するかどうか。
emailAddress: すべての受信メッセージが転送される電子メール アドレス。この電子メール アドレスは、転送アドレスの検証済みメンバーである必要があります。
disposition: メッセージが転送された後に残すべき状態。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.updateAutoForwarding」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateAutoForwarding
gmail_users_settings_sendAs_list
gmail_users_settings_sendAs_list
指定されたアカウントの送信者エイリアスを一覧表示します。結果には、アカウントに関連付けられたプライマリ送信者アドレスとカスタムの「差出人」エイリアスが含まれます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/list
gmail_users_settings_sendAs_get
gmail_users_settings_sendAs_get
指定された送信エイリアスを取得します。指定されたアドレスがコレクションのメンバーではない場合、HTTP 404 エラーで失敗します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: 取得する送信者エイリアス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/get
gmail_users_settings_sendAs_create
gmail_users_settings_sendAs_create
カスタムの「送信元」送信エイリアスを作成します。 SMTP MSA が指定されている場合、Gmail はエイリアスを作成する前に SMTP サービスに接続して構成を検証しようとします。エイリアスの所有権の検証が必要な場合、メッセージが電子メール アドレスに送信され、リソースの検証ステータスが「保留中」に設定されます。それ以外の場合、リソースは検証ステータスが「accepted」に設定されて作成されます。署名が提供されている場合、Gmail はエイリアスを使用して保存する前に HTML をサニタイズします。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
sendAsEmail: このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される電子メール アドレス。これは、作成を除くすべての操作に対して読み取り専用です。
displayName: このエイリアスを使用して送信されるメールの「From:」ヘッダーに表示される名前。カスタムの「差出人」アドレスの場合、これが空の場合、Gmail はアカウントに関連付けられたプライマリ アドレスに使用される名前を「From:」ヘッダーに入力します。管理者がユーザーの名前形式を更新する機能を無効にしている場合、プライマリ ログインのこのフィールドを更新するリクエストは通知なく失敗します。
replyToAddress: このエイリアスを使用して送信されるメールの「Reply-To:」ヘッダーに含まれるオプションの電子メール アドレス。これが空の場合、Gmail は「Reply-To:」ヘッダーを生成しません。
signature: Gmail ウェブ UI でこのエイリアスを使用して作成されたメッセージに含まれるオプションの HTML 署名。この署名は新しいメールにのみ追加されます。
isPrimary: このアドレスがアカウントへのログインに使用されるプライマリ アドレスであるかどうか。すべての Gmail アカウントにはプライマリ アドレスが 1 つだけあり、送信エイリアスのコレクションから削除することはできません。このフィールドは読み取り専用です。
isDefault: 新しいメッセージの作成や休暇中の自動返信の送信などの状況で、このアドレスがデフォルトの「From:」アドレスとして選択されるかどうか。すべての Gmail アカウントにはデフォルトの送信アドレスが 1 つだけあるため、クライアントがこのフィールドに書き込むことができる唯一の正当な値は「true」です。あるアドレスのこれを「false」から「true」に変更すると、このフィールドは他の以前のデフォルトのアドレスでは「false」になります。
treatAsAlias: Gmail がこのアドレスをユーザーのプライマリ電子メール アドレスのエイリアスとして扱うかどうか。この設定は、カスタムの「from」エイリアスにのみ適用されます。
smtpMsa.host: SMTP サービスのホスト名。必須。
smtpMsa.port: SMTP サービスのポート。必須。
smtpMsa.username: SMTP サービスでの認証に使用されるユーザー名。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.password: SMTP サービスでの認証に使用されるパスワード。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.securityMode: SMTP サービスとの通信を保護するために使用されるプロトコル。必須。
verificationStatus: このアドレスが送信エイリアスとして使用できるかどうかが検証されているかどうかを示します。読み取り専用。この設定は、カスタムの「from」エイリアスにのみ適用されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/create
gmail_users_settings_sendAs_update
gmail_users_settings_sendAs_update
send-as エイリアスを更新します。署名が提供されている場合、Gmail はエイリアスを使用して保存する前に HTML をサニタイズします。アカウントのプライマリ アドレス以外のアドレスは、ドメイン全体の権限を委任されたサービス アカウント クライアントによってのみ更新できます。
パラメータ
displayName: このエイリアスを使用して送信されるメールの「From:」ヘッダーに表示される名前。カスタムの「差出人」アドレスの場合、これが空の場合、Gmail はアカウントに関連付けられたプライマリ アドレスに使用される名前を「From:」ヘッダーに入力します。管理者がユーザーの名前形式を更新する機能を無効にしている場合、プライマリ ログインのこのフィールドを更新するリクエストは通知なく失敗します。
replyToAddress: このエイリアスを使用して送信されるメールの「Reply-To:」ヘッダーに含まれるオプションの電子メール アドレス。これが空の場合、Gmail は「Reply-To:」ヘッダーを生成しません。
signature: Gmail ウェブ UI でこのエイリアスを使用して作成されたメッセージに含まれるオプションの HTML 署名。この署名は新しいメールにのみ追加されます。
isPrimary: このアドレスがアカウントへのログインに使用されるプライマリ アドレスであるかどうか。すべての Gmail アカウントにはプライマリ アドレスが 1 つだけあり、送信エイリアスのコレクションから削除することはできません。このフィールドは読み取り専用です。
isDefault: 新しいメッセージの作成や休暇中の自動返信の送信などの状況で、このアドレスがデフォルトの「From:」アドレスとして選択されるかどうか。すべての Gmail アカウントにはデフォルトの送信アドレスが 1 つだけあるため、クライアントがこのフィールドに書き込むことができる唯一の正当な値は「true」です。あるアドレスのこれを「false」から「true」に変更すると、このフィールドは他の以前のデフォルトのアドレスでは「false」になります。
treatAsAlias: Gmail がこのアドレスをユーザーのプライマリ電子メール アドレスのエイリアスとして扱うかどうか。この設定は、カスタムの「from」エイリアスにのみ適用されます。
smtpMsa.host: SMTP サービスのホスト名。必須。
smtpMsa.port: SMTP サービスのポート。必須。
smtpMsa.username: SMTP サービスでの認証に使用されるユーザー名。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.password: SMTP サービスでの認証に使用されるパスワード。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.securityMode: SMTP サービスとの通信を保護するために使用されるプロトコル。必須。
verificationStatus: このアドレスが送信エイリアスとして使用できるかどうかが検証されているかどうかを示します。読み取り専用。この設定は、カスタムの「from」エイリアスにのみ適用されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: 更新する送信者エイリアス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.update」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update
gmail_users_settings_sendAs_patch
gmail_users_settings_sendAs_patch
指定された送信者エイリアスにパッチを適用します。
パラメータ
displayName: このエイリアスを使用して送信されるメールの「From:」ヘッダーに表示される名前。カスタムの「差出人」アドレスの場合、これが空の場合、Gmail はアカウントに関連付けられたプライマリ アドレスに使用される名前を「From:」ヘッダーに入力します。管理者がユーザーの名前形式を更新する機能を無効にしている場合、プライマリ ログインのこのフィールドを更新するリクエストは通知なく失敗します。
replyToAddress: このエイリアスを使用して送信されるメールの「Reply-To:」ヘッダーに含まれるオプションの電子メール アドレス。これが空の場合、Gmail は「Reply-To:」ヘッダーを生成しません。
signature: Gmail ウェブ UI でこのエイリアスを使用して作成されたメッセージに含まれるオプションの HTML 署名。この署名は新しいメールにのみ追加されます。
isPrimary: このアドレスがアカウントへのログインに使用されるプライマリ アドレスであるかどうか。すべての Gmail アカウントにはプライマリ アドレスが 1 つだけあり、送信エイリアスのコレクションから削除することはできません。このフィールドは読み取り専用です。
isDefault: 新しいメッセージの作成や休暇中の自動返信の送信などの状況で、このアドレスがデフォルトの「From:」アドレスとして選択されるかどうか。すべての Gmail アカウントにはデフォルトの送信アドレスが 1 つだけあるため、クライアントがこのフィールドに書き込むことができる唯一の正当な値は「true」です。あるアドレスのこれを「false」から「true」に変更すると、このフィールドは他の以前のデフォルトのアドレスでは「false」になります。
treatAsAlias: Gmail がこのアドレスをユーザーのプライマリ電子メール アドレスのエイリアスとして扱うかどうか。この設定は、カスタムの「from」エイリアスにのみ適用されます。
smtpMsa.host: SMTP サービスのホスト名。必須。
smtpMsa.port: SMTP サービスのポート。必須。
smtpMsa.username: SMTP サービスでの認証に使用されるユーザー名。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.password: SMTP サービスでの認証に使用されるパスワード。これは、SendAs 設定を作成または更新するリクエストで指定できる書き込み専用フィールドです。応答に入力されることはありません。
smtpMsa.securityMode: SMTP サービスとの通信を保護するために使用されるプロトコル。必須。
verificationStatus: このアドレスが送信エイリアスとして使用できるかどうかが検証されているかどうかを示します。読み取り専用。この設定は、カスタムの「from」エイリアスにのみ適用されます。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: 更新する送信者エイリアス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.patch」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/patch
gmail_users_settings_sendAs_delete
gmail_users_settings_sendAs_delete
指定された送信者エイリアスを削除します。使用するために必要な検証をすべて取り消します。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: 削除する送信者エイリアス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/delete
gmail_users_settings_sendAs_verify
gmail_users_settings_sendAs_verify
指定されたエイリアス送信アドレスに確認電子メールを送信します。検証ステータスは「保留中」でなければなりません。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: 検証する送信者エイリアス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.verify」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/verify
gmail_users_settings_sendAs_smimel (1)
gmail_users_settings_sendAs_smimel (1)
指定された send-as エイリアスの S/MIME 構成を一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.smimeInfo.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/list
gmail_users_settings_sendAs_smimel (2)
gmail_users_settings_sendAs_smimel (2)
指定された send-as エイリアスの指定された S/MIME 構成を取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される電子メール アドレス。
id: SmimeInfo の不変 ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.smimeInfo.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/get
gmail_users_settings_sendAs_smimel (3)
gmail_users_settings_sendAs_smimel (3)
指定された send-as エイリアスの指定された S/MIME 構成を削除します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される電子メール アドレス。
id: SmimeInfo の不変 ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.smimeInfo.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/delete
gmail_users_settings_sendAs_smimel (4)
gmail_users_settings_sendAs_smimel (4)
指定された send-as エイリアスのデフォルトの S/MIME 構成を設定します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
sendAsEmail: このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示される電子メール アドレス。
id: SmimeInfo の不変 ID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.sendAs.smimeInfo.setDefault」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs.smimeInfo/setDefault
gmail_users_settings_cse_identitie (1)
gmail_users_settings_cse_identitie (1)
ユーザー アカウントからメールを送信する権限のあるクライアント側の暗号化 ID を作成および構成します。 Google は、Google Workspace 組織内のユーザーがメールを暗号化して ID に送信できるように、S/MIME 証明書をドメイン全体の共有ディレクトリに公開します。
パラメータ
emailAddress: 送信側 ID の電子メール アドレス。電子メール アドレスは、認証されたユーザーのプライマリ電子メール アドレスである必要があります。
primaryKeyPairId: キー ペアが関連付けられている場合は、キー ペアの ID、CseKeyPair。
signAndEncryptKeyPairs.signingKeyPairId: 送信メールに署名する CseKeyPair の ID。
signAndEncryptKeyPairs.encryptionKeyPairId: 署名付き送信メールを暗号化する CseKeyPair の ID。
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.identities.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/create
gmail_users_settings_cse_identitie (2)
gmail_users_settings_cse_identitie (2)
クライアント側の暗号化 ID を削除します。認証されたユーザーは、その ID を使用して暗号化されたメッセージを送信できなくなります。 ID を削除した後に復元することはできません。代わりに、CreateCseIdentity メソッドを使用して、同じ構成で別の ID を作成します。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
cseEmailAddress: 削除されたクライアント側の暗号化 ID 構成に関連付けられたプライマリ電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.identities.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/delete
gmail_users_settings_cse_identitie (3)
gmail_users_settings_cse_identitie (3)
クライアント側の暗号化 ID 構成を取得します。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
cseEmailAddress: 取得されたクライアント側の暗号化 ID 構成に関連付けられたプライマリ電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.identities.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/get
gmail_users_settings_cse_identitie (4)
gmail_users_settings_cse_identitie (4)
認証されたユーザーのクライアント側で暗号化された ID をリストします。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
pageToken: ID のどのページを返すかを示すページネーション トークン。トークンが指定されていない場合、API は結果の最初のページを返します。
pageSize: 返される ID の数。指定しない場合、ページ サイズはデフォルトで 20 エントリになります。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.identities.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/list
gmail_users_settings_cse_identitie (5)
gmail_users_settings_cse_identitie (5)
別のキー ペアを既存のクライアント側暗号化 ID に関連付けます。更新されたキー ペアは、Google の [S/MIME 証明書プロファイル](https://support.google.com/a/answer/7300887) に対して検証する必要があります。
パラメータ
primaryKeyPairId: キー ペアが関連付けられている場合は、キー ペアの ID、CseKeyPair。
signAndEncryptKeyPairs.signingKeyPairId: 送信メールに署名する CseKeyPair の ID。
signAndEncryptKeyPairs.encryptionKeyPairId: 署名付き送信メールを暗号化する CseKeyPair の ID。
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
emailAddress: 更新するクライアント側の暗号化 ID の電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.identities.patch」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.identities/patch
gmail_users_settings_cse_keypairs (1)
gmail_users_settings_cse_keypairs (1)
認証されたユーザーのクライアント側暗号化 S/MIME 公開キー証明書チェーンと秘密キー メタデータを作成してアップロードします。
パラメータ
pkcs7: 入力のみ。公開キーとその証明書チェーン。チェーンは [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) 形式であり、PEM エンコーディングと ASCII アーマーを使用する必要があります。
privateKeyMetadata: このキー ペアの秘密キーのインスタンスのメタデータ。
kaclsKeyMetadata.kaclsUri: 秘密キーを管理するキー アクセス制御リスト サービスの URI。
kaclsKeyMetadata.kaclsData: キー アクセス制御リスト サービスによって生成および使用される不透明なデータ。最大サイズ: 8 KiB。
hardwareKeyMetadata.description: ハードウェアキーについての説明です。
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.keypairs.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/create
gmail_users_settings_cse_keypairs (2)
gmail_users_settings_cse_keypairs (2)
クライアント側の暗号化キーのペアをオフにします。認証されたユーザーは、キー ペアを使用して受信 CSE メッセージ テキストを復号したり、送信 CSE メールに署名したりできなくなります。アクセスを回復するには、EnableCseKeyPair を使用してキー ペアをオンにします。 30 日後、ObliterateCseKeyPair メソッドを使用してキー ペアを完全に削除できます。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
keyPairId: オフにするキーペアの識別子。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.keypairs.enable」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/enable
gmail_users_settings_cse_keypairs (3)
gmail_users_settings_cse_keypairs (3)
オフになっていたクライアント側の暗号化キーのペアをオンにします。キー ペアは、関連付けられたクライアント側の暗号化 ID に対して再びアクティブになります。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
keyPairId: オンにするキー ペアの識別子。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.keypairs.disable」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/disable
gmail_users_settings_cse_keypairs (4)
gmail_users_settings_cse_keypairs (4)
既存のクライアント側の暗号化キーのペアを取得します。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
keyPairId: 取得するキーペアの識別子。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.keypairs.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/get
gmail_users_settings_cse_keypairs (5)
gmail_users_settings_cse_keypairs (5)
認証されたユーザーのクライアント側の暗号化キーのペアを一覧表示します。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
pageToken: キー ペアのどのページを返すかを示すページネーション トークン。トークンが指定されていない場合、API は結果の最初のページを返します。
pageSize: 返されるキーペアの数。指定しない場合、ページ サイズはデフォルトで 20 エントリになります。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.cse.keypairs.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/list
gmail_users_settings_cse_keypairs (6)
gmail_users_settings_cse_keypairs (6)
クライアント側の暗号化キーのペアを永久的かつ即時に削除します。完全に削除できるのは、30 日以上オフになっているキー ペアのみです。キー ペアをオフにするには、DisableCseKeyPair メソッドを使用します。 Gmail では、消去されたキーで暗号化されたメッセージを復元したり復号したりすることはできません。認証されたユーザーと Google Workspace 管理者は、暗号化されたメッセージを読み取るアクセス権を失います。
パラメータ
userId: リクエスタのプライマリ電子メール アドレス。認証されたユーザーを示すには、特別な値「me」を使用できます。
keyPairId: 削除するキーペアの識別子。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンスa
Gmail リファレンス 「Method: users.settings.cse.keypairs.obliterate」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.cse.keypairs/obliterate
gmail_users_settings_filters_list
gmail_users_settings_filters_list
Gmail ユーザーのメッセージ フィルターを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.filters.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/list
gmail_users_settings_filters_get
gmail_users_settings_filters_get
フィルターを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 取得するフィルターのID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.filters.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/get
gmail_users_settings_filters_create
gmail_users_settings_filters_create
フィルターを作成します。注: 作成できるフィルタは最大 1,000 個のみです。
パラメータ
id: サーバーが割り当てたフィルターの ID。
criteria.from: 送信者の表示名または電子メール アドレス。
criteria.to: 受信者の表示名または電子メール アドレス。 「to」、「cc」、および「bcc」ヘッダー フィールドに受信者が含まれます。電子メール アドレスのローカル部分のみを使用できます。たとえば、「example」と「example@」は両方とも「example@gmail.com」と一致します。このフィールドでは大文字と小文字が区別されません。
criteria.subject: メッセージの件名に大文字と小文字を区別しないフレーズが見つかりました。末尾と先頭の空白はトリミングされ、隣接する空白は折りたたまれます。
criteria.query: 指定されたクエリに一致するメッセージのみを返します。 Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、「from:someuser@example.com rfc822msgid: is:unread」`。
criteria.negatedQuery: 指定されたクエリに一致しないメッセージのみを返します。 Gmail の検索ボックスと同じクエリ形式をサポートします。たとえば、「from:someuser@example.com rfc822msgid: is:unread」`。
criteria.hasAttachment: メッセージに添付ファイルがあるかどうか。
criteria.excludeChats: 応答でチャットを除外するかどうか。
criteria.size: すべてのヘッダーと添付ファイルを含む、RFC822 メッセージ全体のサイズ (バイト単位)。
criteria.sizeComparison: サイズフィールドに対するメッセージサイズのバイト単位の関係。
action.addLabelIds: メッセージに追加するラベルのリスト。
action.removeLabelIds: メッセージから削除するラベルのリスト。
action.forward: メッセージの転送先となる電子メール アドレス。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.filters.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/create
gmail_users_settings_filters_delete
gmail_users_settings_filters_delete
指定されたフィルターを即時かつ永久に削除します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
id: 削除するフィルターのID。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.filters.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.filters/delete
gmail_users_settings_forwardingAdd (1)
gmail_users_settings_forwardingAdd (1)
指定されたアカウントの転送アドレスを一覧表示します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.forwardingAddresses.list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/list
gmail_users_settings_forwardingAdd (2)
gmail_users_settings_forwardingAdd (2)
指定された転送先アドレスを取得します。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
forwardingEmail: 取得する転送アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.forwardingAddresses.get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/get
gmail_users_settings_forwardingAdd (3)
gmail_users_settings_forwardingAdd (3)
転送先アドレスを作成します。所有権の検証が必要な場合、メッセージが受信者に送信され、リソースの検証ステータスが「保留中」に設定されます。それ以外の場合、リソースは検証ステータスが「accepted」に設定されて作成されます。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
forwardingEmail: メッセージを転送できる電子メール アドレス。
verificationStatus: このアドレスが検証されており、転送に使用できるかどうかを示します。読み取り専用。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.forwardingAddresses.create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/create
gmail_users_settings_forwardingAdd (4)
gmail_users_settings_forwardingAdd (4)
指定された転送アドレスを削除し、必要な検証をすべて取り消します。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
forwardingEmail: 削除する転送アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.forwardingAddresses.delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/delete
gmail_users_settings_delegates_list
gmail_users_settings_delegates_list
指定されたアカウントの代理人を一覧表示します。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.delegates_list」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/list
gmail_users_settings_delegates_get
gmail_users_settings_delegates_get
指定されたデリゲートを取得します。代理ユーザーは、電子メール エイリアスではなく、プライマリ電子メール アドレスで参照する必要があることに注意してください。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
delegateEmail: 代理関係を取得するユーザーの電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.delegates_get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/get
gmail_users_settings_delegates_get
gmail_users_settings_delegates_get
指定されたデリゲートを取得します。代理ユーザーは、電子メール エイリアスではなく、プライマリ電子メール アドレスで参照する必要があることに注意してください。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
delegateEmail: 代理関係を取得するユーザーの電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.delegates_get」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/get
gmail_users_settings_delegates_cre
gmail_users_settings_delegates_cre
検証電子メールを送信せずに、検証ステータスを直接「承認済み」に設定してデリゲートを追加します。代理ユーザーは、代理ユーザーと同じ Google Workspace 組織のメンバーである必要があります。 Gmail では、Google Workspace 組織内の各ユーザーが持つことができる代理人と委任者の数に制限が設けられています。これらの制限は組織によって異なりますが、通常、各ユーザーは最大 25 人の代理人、最大 10 人の代理人を持つことができます。代理ユーザーは、電子メール エイリアスではなく、プライマリ電子メール アドレスで参照する必要があることに注意してください。また、新しいデリゲートが作成されると、新しいデリゲートが使用可能になるまでに最大 1 分の遅延が発生する可能性があるこ
パラメータ
delegateEmail: 代理人の電子メール アドレス。
verificationStatus: このアドレスが検証済みで、アカウントの代理人として機能できるかどうかを示します。読み取り専用。
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.delegates_create」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/create
gmail_users_settings_delegates_del
gmail_users_settings_delegates_del
指定されたデリゲート (任意の検証ステータスのもの) を削除し、それを使用するために必要な検証をすべて取り消します。代理ユーザーは、電子メール エイリアスではなく、プライマリ電子メール アドレスで参照する必要があることに注意してください。この方法は、ドメイン全体の権限を委任されたサービス アカウント クライアントのみが使用できます。
パラメータ
userId: ユーザーの電子メール アドレス。特別な値「me」を使用して、認証されたユーザーを示すことができます。
delegateEmail: 代理人として削除されるユーザーの電子メール アドレス。
access_token: OAuth アクセス トークン。
alt: レスポンスのデータ形式。
callback: JSONP
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: サーバー側アプリケーションのクォータ目的に使用できます。ユーザーに割り当てる任意の文字列を指定できますが、40 文字を超えてはなりません。
upload_protocol: メディアのアップロード プロトコル (「raw」、「multipart」など)。
uploadType: メディア用の従来のアップロード プロトコル (「メディア」、「マルチパート」など)。
$.xgafv: V1 エラー形式。
レスポンス
Gmail リファレンス 「Method: users.settings.delegates_delete」 参照: https://developers.google.com/gmail/api/reference/rest/v1/users.settings.delegates/delete
Report abuse