アクティビティを作成または置換する

[アーティクル]
06/22/2024

名前空間: microsoft.graph

アプリの新しいユーザーアクティビティを作成するか、既存のユーザーアクティビティを置き換えます。 1 つの要求でユーザーアクティビティとその関連 アクティビティHistoryItems を作成する場合は、ディープ挿入を使用できます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	UserActivity.ReadWrite.CreatedByApp	注意事項なし。
委任 (個人用 Microsoft アカウント)	UserActivity.ReadWrite.CreatedByApp	注意事項なし。
アプリケーション	サポートされていません。	サポートされていません。

HTTP 要求

PUT /me/activities/{appActivityId}

手記： URL の appActivityId は URL セーフである必要がありますが (RFC 2396 予約されていない文字を除くすべての文字を 16 進表現に変換する必要があります)、元の appActivityId は URL セーフである必要はありません。

要求ヘッダー

名前	種類	説明
Authorization	string	ベアラー {token}。必須です。認証と認可についての詳細をご覧ください。

要求本文

要求本文で、アクティビティオブジェクトの JSON 表現を指定します。

応答

成功した場合、このメソッドは、アクティビティが作成された場合は 201 Created 応答コードを返し、アクティビティが置き換えられた場合は 200 OK します。

例

例 1: アクティビティを作成する

要求

次の例は要求を示しています。

HTTP
JavaScript

PUT https://graph.microsoft.com/v1.0/me/activities/3F12345
Content-type: application/json

{
  "activitySourceHost": "https://contoso.com",
  "createdDateTime": "2017-06-09T20:54:43.969Z",
  "lastModifiedDateTime": "2017-06-09T20:54:43.969Z",
  "id": "14332800362997268276",
  "appActivityId": "/article?12345",
  "status": "updated",
  "expirationDateTime": "2017-02-26T20:20:48.114Z",
  "visualElements": {
    "displayText": "Contoso How-To: How to Tie a Reef Knot",
    "description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
    "attribution": {
      "iconUrl": "https://www.contoso.com/icon",
      "alternateText": "Contoso Ltd",
      "addImageQuery": false
    },
    "backgroundColor": "#ff0000",
    "content": {
      "$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
      "type": "AdaptiveCard",
      "body": [
        {
          "type": "TextBlock",
          "text": "Contoso MainPage"
        }
      ]
    }
  }
}


const options = {
	authProvider,
};

const client = Client.init(options);

const userActivity = {
  activitySourceHost: 'https://contoso.com',
  createdDateTime: '2017-06-09T20:54:43.969Z',
  lastModifiedDateTime: '2017-06-09T20:54:43.969Z',
  id: '14332800362997268276',
  appActivityId: '/article?12345',
  status: 'updated',
  expirationDateTime: '2017-02-26T20:20:48.114Z',
  visualElements: {
    displayText: 'Contoso How-To: How to Tie a Reef Knot',
    description: 'How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.',
    attribution: {
      iconUrl: 'https://www.contoso.com/icon',
      alternateText: 'Contoso Ltd',
      addImageQuery: false
    },
    backgroundColor: '#ff0000',
    content: {
      '$schema': 'https://adaptivecards.io/schemas/adaptive-card.json',
      type: 'AdaptiveCard',
      body: [
        {
          type: 'TextBlock',
          text: 'Contoso MainPage'
        }
      ]
    }
  }
};

await client.api('/me/activities/3F12345')
	.put(userActivity);

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "activitySourceHost": "https://contoso.com",
  "createdDateTime": "2017-06-09T20:54:43.969Z",
  "lastModifiedDateTime": "2017-06-09T20:54:43.969Z",
  "id": "14332800362997268276",
  "appActivityId": "/article?12345",
  "status": "updated",
  "expirationDateTime": "2017-02-26T20:20:48.114Z",
  "visualElements": {
    "displayText": "Contoso How-To: How to Tie a Reef Knot",
    "description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
    "attribution": {
      "iconUrl": "https://www.contoso.com/icon",
      "alternateText": "Contoso, Ltd.",
      "addImageQuery": false
    },
    "backgroundColor": "#ff0000",
    "content": {
      "$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
      "type": "AdaptiveCard",
      "body": [
        {
          "type": "TextBlock",
          "text": "Contoso MainPage"
        }
      ]
    }
  },
  "activationUrl": "https://www.contoso.com/article?id=12345",
  "appDisplayName": "Contoso, Ltd.",
  "userTimezone": "Africa/Casablanca",
  "fallbackUrl": "https://www.contoso.com/article?id=12345",
  "contentUrl": "https://www.contoso.com/article?id=12345",
  "contentInfo": {
    "@context": "https://schema.org",
    "@type": "Article",
    "author": "Jennifer Booth",
    "name": "How to Tie a Reef Knot"
  }
}

例 2: ディープ挿入

この例では、1 つの要求で、そのアクティビティの新しいアクティビティと履歴項目を作成します。

要求