名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
チームはチャネルで構成されています。チャネルは、チームのメンバーと会話する場所です。 各チャネルは、特定のトピック、部門、プロジェクト専用です。 チャネルは、実際に作業を行う場所、チーム全体に対してテキスト、音声、ビデオによる会話を公開する場所、ファイルを共有する場所、タブを追加する場所です。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャネルを一覧表示する | channel コレクション | チーム内のチャネルの一覧を取得します。 |
| 受信チャネルを一覧表示する | channel コレクション | チームと共有されているチャネルの一覧を取得します。 |
| すべてのチャネルを一覧表示する | channel コレクション | チーム内またはこのチームと共有されているチャネル (受信チャネル) の一覧を取得します。 |
| チャネルを作成する | channel | 表示名と説明を指定して新しいチャネルを作成します。 |
| チャネルを取得する | channel | チャネルのプロパティとリレーションシップを読み取ります。 |
| プライマリ チャネルを取得する | channel | チームの全般チャネル。 |
| チャネルを更新する | channel | チャネルのプロパティを更新します。 |
| チャネルを削除する | なし | チャネルを削除します。 |
| チャネル メッセージを一覧表示する | chatMessage | チャネルのメッセージを取得します。 |
| 全チャネル メッセージ取得 API が追加されました | channel コレクション | ユーザーが参加しているすべてのチャネルからすべてのメッセージを取得します。 |
| 保持されているすべてのチャネル メッセージを取得する | chatMessage コレクション | チーム内のすべてのチャネルにわたって保持されているすべてのメッセージを取得します。 |
| チャネル メッセージの投稿を作成する | chatMessage | メッセージをチャネルに送信します。 |
| チャネル メッセージの投稿への返信を作成する | chatMessage | チャネル内のメッセージに返信します。 |
| ファイル フォルダーを取得する | driveItem | チャネルのファイルが保存されている SharePoint フォルダーの詳細情報を取得します。 |
| タブを一覧表示する | teamsTab | チャネルにピン留めされているタブを一覧表示します。 |
| チャネル メンバーを一覧表示する | conversationMember コレクション | 標準、プライベート、共有チャネルの直接 メンバー を含む、 チャネル内のメンバーの一覧を取得します。 |
| すべてのメンバーを一覧表示する | conversationMember コレクション | チャネル内のすべての メンバー の一覧を取得 します。 |
| チャネル allMembers コレクションからメンバーを取得する | conversationMember | メンバーシップ ID を使用して、 allMembers コレクションから 1 つの conversationMember (直接または間接) を取得します。 |
| チャネル メンバーを追加する | conversationMember | チャネルにメンバーを追加します。
membershipType が private またはshared のチャネルのみサポートされます。 |
| チャネル メンバーを取得する | conversationMember コレクション | チャネルのメンバーを取得します。 |
| チャネルをアーカイブする | なし | チャネルをアーカイブします。 |
| チャネルのアーカイブを解除する | なし | チャネルのアーカイブを解除します。 |
| チャネル メンバーの役割を更新する | conversationMember | チャネルのメンバーのプロパティを更新します。
membershipType が private またはshared のチャネルのみサポートされます。 |
| チャネル メンバーを削除する | なし | チャネルからメンバーを削除します。
membershipType が private またはshared のチャネルのみサポートされます。 |
| 移行を開始する | channel | 既存のチャネルで移行モードを有効にして、外部メッセージの移行を開始 します。 |
| Complete migration | channel | 既存のチャネルまたは新しい チャネル での移行を完了します。 |
| チャネル内のリスト タブ | teamsTab | チャネルにピン留めされているタブを一覧表示します。 |
| チャネルにタブを追加する | teamsTab | チャネルにタブを追加 (pin) します。 |
| チャネルの [取得] タブ | teamsTab | チャネルにピン留めされているタブを読み取ります。 |
| チャネルの [更新] タブ | teamsTab | チャネル内のタブのプロパティを更新します。 |
| チャネルからタブを削除する | なし | チャネルからタブを削除 (ピン留め解除) します。 |
| チャネルのメールアドレスをプロビジョニングする | provisionChannelEmailResult | チャネルのメール アドレスをプロビジョニングします。 |
| チャネルのメールアドレスを削除する | なし | チャネルのメール アドレスを削除します。 |
| 受信チャネルを削除する | なし | チームから受信チャネル (チームと共有されているチャネル) を削除します。 |
| チャネルを共有するチームを一覧表示する | sharedWithChannelTeamInfo コレクション | 指定したチャネルを共有するチームの一覧を取得します。 |
| チャネルを共有するチームを取得する | sharedWithChannelTeamInfo | 指定したチャネルを共有するチームを取得します。 |
| チームとのチャネルの共有を解除する | なし | チームとチャネルの共有を解除します。 |
| 許可されているメンバーを一覧表示する | conversationMember コレクション | 共有チャネルにアクセスできるチーム メンバーの一覧を取得します。 |
| ユーザー アクセスを確認する | ブール型 | ユーザーが共有チャネルにアクセスできるかどうかを確認します。 |
| Planner | ||
| 計画を一覧表示する | plannerPlan コレクション | Teams の共有チャネルが所有する plannerPlan オブジェクトの一覧を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| description | String | チャネルの説明テキストです (省略可能)。 |
| displayName | 文字列 | Microsoft Teamsでユーザーに表示されるチャネル名。 最大長は 50 文字です。 |
| id | String | チャネルの一意の識別子。 読み取り専用。 |
| isFavoriteByDefault | ブール値 | チームのすべてのメンバーがチャネルリストに表示するために、チャネルを推奨としてマークする必要があるかどうかを示します。
メモ： 推奨されるすべてのチャネルは、教育現場のワーカー ユーザーのチャネル 一覧に自動的に表示されます。 プロパティは、 Create team メソッドを使用してのみプログラムで設定できます。 既定値は false です。 |
| migrationMode | migrationMode | チャネルが移行モードであるかどうかを示します。 この値は、移行モードに入らなかったチャネルに対して null されます。 使用可能な値: inProgress、completed、unknownFutureValue。 |
| メール | String | チャネルにメッセージを送信するときのメール アドレス。 読み取り専用です。 |
| webUrl | String | Microsoft Teamsのチャネルへのハイパーリンク。 この URL は、Microsoft Teamsでチャネルを右クリックし、[チャネルへのリンクを取得] を選択したときに提供されます。 この URL は不透明 blob として扱われる必要があり、また解析されません。 読み取り専用。 |
| membershipType | channelMembershipType | チャネルの種類。 作成中に設定でき、変更できません。 使用可能な値: standard、private、unknownFutureValue、shared。 既定値は standard です。
Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型の次のメンバーを取得します:shared。 |
| layoutType | channelLayoutType | チャネルのレイアウトの種類。 作成時に設定でき、更新できます。 使用可能な値: post、chat、unknownFutureValue。 既定値は post です。
postレイアウトのチャネルでは、従来の返信後の会話形式が使用されますが、chat レイアウトのチャネルでは、グループ チャットと同様のチャットのようなスレッドエクスペリエンスが提供されます。 |
| createdDateTime | dateTimeOffset | 読み取り専用です。 チャネルが作成されたときのタイムスタンプ。 |
| moderationSettings | channelModerationSettings | 新しい投稿を開始できるユーザーとそのチャネルの投稿に返信できるユーザーを、そのチャネル内で制御するため、チャネルのモデレーションを構成します。 |
| originalCreatedDateTime | dateTimeOffset | チャネルの元の作成時刻のタイムスタンプ。 チャネルが移行モードに入らなかった場合、値は null されます。 |
| 概要 | channelSummary | チャネルに関する概要情報 (ゲストの数、メンバー、所有者、他のテナントからのメンバーのインジケーターなど) が含まれます。
summary プロパティは、Get チャネル メソッドの $select 句に表示される場合にのみ返されます。 |
| tenantId | string | Microsoft Entra テナントの ID。 |
| isArchived | Boolean | チャネルがアーカイブされているかどうかを示します。 読み取り専用です。 |
channelMembershipType 値
| メンバー | 説明 |
|---|---|
| 標準 | チャネルは、親チームのメンバーの一覧を継承します。 |
| プライベート | チャネルには、親チーム上のすべてのメンバーのサブセットであるメンバーを含めることができます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
| 共有 | メンバーは、チームに追加せずにチャネルに直接追加できます。 |
migrationMode 値
| メンバー | 説明 |
|---|---|
| inProgress | チャネルまたはチャットが移行モードに入った。 |
| 完了 | チャネルまたはチャットが移行モードから外れている。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
インスタンスの属性
インスタンスの属性は、動作が特殊なプロパティです。 これらのプロパティは一時的なものです。 サービスが実行する動作を定義するか、有効期限が切れるアイテムのダウンロード URL などの短期的なプロパティ値を指定します。
| プロパティ名 | 種類 | 説明 |
|---|---|---|
| @microsoft.graph.channelCreationMode | string | チャネルが移行の状態にあり、現在移行の目的で使用されていることを示します。 1 つの値 migration を受け入れます。 |
注:
channelCreationModeは、値migrationを受け取る列挙型です。
POST リクエストの例については、「リクエスト （移行状態でチャネルを作成する）」をご覧ください。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| allMembers | conversationMember コレクション | チャネルに関連付けられているメンバーシップ レコードのコレクション。 これには、共有チャネルの直接メンバーと間接メンバーの両方が含まれます。 |
| filesFolder | driveItem | チャネルのファイルが保存されている場所のメタデータ。 |
| members | conversationMember コレクション | チャネルに関連付けられているメンバーシップ レコードのコレクション。 |
| messages | chatMessage コレクション | チャネル内のすべてのメッセージのコレクションです。 Null 許容型。 |
| operations | teamsAsyncOperation コレクション | このチームで実行済みまたは実行中の非同期操作です。 |
| planner | teamsChannelPlanner | このチャネルで使用できる選択的 Planner サービス。 現在、共有チャネルのみがサポートされています。 読み取り専用です。 Null 許容型。 |
| sharedWithTeams | sharedWithChannelTeamInfo コレクション | チャネルが共有されているチームのコレクション。 |
| tabs | teamsTab コレクション | チャネル内のすべてのタブのコレクションです。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"isFavoriteByDefault": true,
"email": "string",
"webUrl": "string",
"membershipType": "String",
"migrationMode": "String",
"layoutType": "string",
"isArchived": false,
"createdDateTime": "string (timestamp)",
"originalCreatedDateTime": "String (timestamp)",
"moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}