コレクションサービスを構成する

コレクションサービスのRESTful APIエンドポイント

Version:

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このトピックでは、コレクションサービスへのアクセスに使用できるRESTful APIエンドポイントについて説明します。

認証

すべての収集サービスエンドポイントは公開されており、認証や承認は必要ありません。

相互作用

このエンドポイントを使用して、コレクションサービスに新しいインタラクションを追加します。各リクエストには、application/jsonの値を持つContent-Typeヘッダーが含まれている必要があります。

動詞	PUT
関連URL	/interaction

要求本文にはJSONオブジェクトが含まれている必要があります。JSONオブジェクトには、いくつかのプロパティを含めることができます。

操作が成功すると、ステータスコード201 (作成済み) が返されます。メッセージ本文には、作成されたインタラクションIDが含まれています。

エラーは、次のいずれかの応答を返します。

Response	Description
400	不正なリクエストです。これは、サーバーが要求を受け入れないことを示しています (パラメータが無効である可能性があります)。また、リクエストを繰り返さないようにすることも示しています。エラーテキストの本文には、エラーメッセージテキストが含まれています。
500	内部サーバーエラー。エラーテキストの本文は、空にすることも、エラーメッセージの配列 (Msg1, Msg2を含めることもできます。

interactionリクエストの例を次に示します。

PUT https://ut/interaction
Content-Type: application/json
{
    "ChannelId":"27b4e611-a73d-4a95-b20a-811d295bdf77",
        "Initiator":"contact",
        "Contact":{
            "Source":"demosrc",
            "Identifier":"demoident"
    },
    "UserAgent":"Mozilla/5.0(NintendoSwitch;ShareApplet)AppleWebKit/601.6(KHTML,likeGecko)NF/4.0.0.5.9NintendoBrowser/5.1.0.13341.",
    "Events":[
        {
            "type":"event",
            "Timestamp":"2019-01-02T11:11:11.528",
            "DefinitionId":"2DB21B3F-DA14-4AAB-AA6C-C6FCF45FFBF5",
            "EventUniqueId":"ff45c5a2-fb30-4985-99b7-88c725ab3df1"
        }
    ]
}

出来事

このエンドポイントを使用して、新しいイベントをコレクションサービスに追加します。各リクエストには、application/jsonの値を持つContent-Typeヘッダーが含まれている必要があります。

動詞	PUT
関連URL	/event

イベント要求本文に含めることができるイベントは多数あります。

操作が成功すると、ステータスコード201 (Created) が空のメッセージ本文と共に返されます。

エラーは、次のいずれかの応答を返します。

Response	Description
400	不正なリクエストです。これは、サーバーが要求を受け入れないことを示しています (パラメータが無効である可能性があります)。また、リクエストを繰り返さないようにすることも示しています。エラーテキストの本文には、エラーメッセージの配列Msg1, Msg2が含まれています。
500	内部サーバーエラー。エラーテキストの本文には、エラーメッセージの配列Msg1, Msg2が含まれています。

eventリクエストの例を次に示します。

PUT https://ut/event
Content-Type: application/json
[
    {
        "type":"event",
        "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
        "Timestamp":"2018-10-25T14:12:01.766Z",
        "Duration":"0.0:00:45.123",
        "DefinitionId":"B826EFFC-D90A-4504-8430-1884F01F7BDF"
    },
    {
        "type":"pageview",
        "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
        "Timestamp":"2018-10-26T14:13:01.766Z",
        "Duration":"0.0:00:11.124",
        "EventDefinitionId":"9326CB1E-CEC8-48F2-9A3E-91C7DBB2166C",
        "ItemLanguage":"by",
        "ItemVersion":2,
        "ItemId":"EFB92FA2-29A0-4A21-8DB7-5C9251C05AAF",
        "Url":"/",
        "SitecoreRenderingDevice":{"Id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","Name":"Default"}
    },
    {
        "type":"campaign",
        "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
        "Timestamp":"2018-10-26T14:14:48.766Z",
        "EventUniqueId":"ff45c5a2-fb30-4985-99b7-88c725ab3df5",
        "Duration":"0.0:00:10.124",
        "EventDefinitionId":"F358D040-256F-4FC6-B2A1-739ACA2B2983",
        "CampaignDefinitionId":"110d559f-dea5-42ea-9c1c-8a5df7e70ef9"
    },
    {
        "type":"download",
        "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
        "Timestamp":"2018-10-25T08:39:48.766Z",
        "Duration":"0.0:00:10.124",
        "EventDefinitionId":"FA72E131-3CFD-481C-8E15-04496E9586DC"
    }
]

完成

このエンドポイントを使用して、インタラクションを完了します。

動詞	POST
関連URL	/interaction/complete

リクエスト本文には、完了するインタラクションのIDが含まれている必要があります。

操作が成功すると、ステータスコード202 (Accepted) とメッセージコンテンツtrueが返されます。

エラーは、次の応答を返します。

Response	Description
400	不正なリクエストです。これは、サーバーが要求を受け入れないことを示しています (パラメータが無効である可能性があります)。また、リクエストを繰り返さないようにすることも示しています。エラー・テキストの本文には、エラー・テキストまたはエラー・メッセージの配列 (Msg1, Msg2) が含まれます。

completeリクエストの例を次に示します。

POST https://ut/interaction/complete
"6914c965-9c27-4777-9110-12c224e2e810"

この記事を改善するための提案がある場合は、お知らせください!

コレクション サービスのRESTful APIエンドポイント

認証

相互作用

出来事

完成

コレクションサービスのRESTful APIエンドポイント