xConnectコレクションモデルの拡張に関するチュートリアルシリーズ

チュートリアル: 連絡先の取得

Version:

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

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

このチュートリアルは、xConnectコレクションモデルの拡張チュートリアルシリーズのパート3です。このチュートリアルを完了するには、まずチュートリアルパート1と2を完了する必要があります。

このチュートリアルでは、次の方法について説明します。

連絡先識別子から連絡先を取得する
連絡先のインタラクションを取得する
インタラクションを取得する

連絡先識別子から連絡先を取得する

連絡先識別子から連絡先を取得するには:

Visual StudioのSolution Explorerで、Program.csファイルをダブルクリックし、内容を次のコードで置き換えます。

using Sitecore.XConnect;
using Sitecore.XConnect.Client;
using Sitecore.XConnect.Client.WebApi;
using Sitecore.XConnect.Collection.Model;
using Sitecore.XConnect.Schema;
using Sitecore.Xdb.Common.Web;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace Sitecore.Documentation
{
    public class Program
    {
        // From <xConnect instance>\App_Config\AppSettings.config
        const string CERTIFICATE_OPTIONS = 
            "StoreName=My;StoreLocation=LocalMachine;FindType=FindByThumbprint;FindValue=???";

        // From your installation
        const string XCONNECT_URL = "https://???XConnect.local";

        // From the previous xConnect walkthrough
        const string CONTACT_IDENTIFIER = "myrtlesitecore???";

        private static void Main(string[] args)
        {
            MainAsync(args).ConfigureAwait(false).GetAwaiter().GetResult();
            System.Console.ForegroundColor = ConsoleColor.DarkGreen;
            System.Console.WriteLine("");
            Console.WriteLine("END OF PROGRAM.");
            Console.ReadKey();
        }

        private static async Task MainAsync(string[] args)
        {
            CertificateHttpClientHandlerModifierOptions options = CertificateHttpClientHandlerModifierOptions.Parse(CERTIFICATE_OPTIONS);

            var certificateModifier = new CertificateHttpClientHandlerModifier(options);

            List<IHttpClientModifier> clientModifiers = new List<IHttpClientModifier>();
            var timeoutClientModifier = new TimeoutHttpClientModifier(new TimeSpan(0, 0, 20));
            clientModifiers.Add(timeoutClientModifier);

            var collectionClient = new CollectionWebApiClient(
                new Uri(XCONNECT_URL + "/odata"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var searchClient = new SearchWebApiClient(
                new Uri(XCONNECT_URL + "/odata"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var configurationClient = new ConfigurationWebApiClient(
                new Uri(XCONNECT_URL + "/configuration"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var cfg = new XConnectClientConfiguration(
                new XdbRuntimeModel(CollectionModel.Model),
                collectionClient,
                searchClient,
                configurationClient
            );

            try
            {
                cfg.Initialize();

                // Print xConnect if configuration is valid
                var arr = new[]
                {
                    @"            ______                                                       __     ",
                    @"           /      \                                                     |  \    ",
                    @" __    __ |  $$$$$$\  ______   _______   _______    ______    _______  _| $$_   ",
                    @"|  \  /  \| $$   \$$ /      \ |       \ |       \  /      \  /       \|   $$ \  ",
                    @"\$$\/  $$| $$      |  $$$$$$\| $$$$$$$\| $$$$$$$\|  $$$$$$\|  $$$$$$$ \$$$$$$   ",
                    @" >$$  $$ | $$   __ | $$  | $$| $$  | $$| $$  | $$| $$    $$| $$        | $$ __  ",
                    @" /  $$$$\ | $$__/  \| $$__/ $$| $$  | $$| $$  | $$| $$$$$$$$| $$_____   | $$|  \",
                    @"|  $$ \$$\ \$$    $$ \$$    $$| $$  | $$| $$  | $$ \$$     \ \$$     \   \$$  $$",
                    @" \$$   \$$  \$$$$$$   \$$$$$$  \$$   \$$ \$$   \$$  \$$$$$$$  \$$$$$$$    \$$$$ "
                };
                Console.WindowWidth = 160;
                foreach (string line in arr)
                    Console.WriteLine(line);

            }
            catch (XdbModelConflictException ce)
            {
                Console.WriteLine("ERROR:" + ce.Message);
                return;
            }

            // Initialize a client using the validated configuration
            using (var client = new XConnectClient(cfg))
            {
                try
                {
                    // Get a known contact
                    IdentifiedContactReference reference = new IdentifiedContactReference(
                        "twitter",
                        CONTACT_IDENTIFIER
                    );

                    Contact existingContact = await client.GetAsync<Contact>(
                        reference,
                        new ContactExpandOptions(new string[] { 
                            PersonalInformation.DefaultFacetKey
                        })
                    );

                    PersonalInformation existingContactFacet = existingContact.GetFacet<PersonalInformation>(PersonalInformation.DefaultFacetKey);

                    Console.WriteLine("Contact ID: " + existingContact.Id.ToString());
                    Console.WriteLine("Contact Name: " + existingContactFacet.FirstName);

                    Console.ReadLine();
                }
                catch (XdbExecutionException ex)
                {
                    // Deal with exception
                }
            }
        }
    }
}

CERTIFICATE_THUMBPRINT、XCONNECT_URL、およびCONTACT IDENTIFIER定数を編集します。
Program.csファイルを保存します。
F5キーを押してアプリを実行します。接続が確立されると、アプリはターミナルに次のように書き込みます。
- 連絡先ID。
- 連絡先の名前。

大事な

ファセットを取得するには、の一部として明示的にリクエストする必要がありますContactExpandOptions。 ContactExpandOptionsせずにコードを実行すると、ファセットがNULLになり、使用しようとすると例外エラーが発生します。

手記

通常、外部システムは連絡先IDの格納に使用されないため、連絡先IDを受け入れる .Get<Contact> オーバーロードを使用する可能性は低いです。

連絡先のインタラクションを取得する

連絡先のインタラクションを取得するには、ContactExpandOptionsのInteractionsプロパティを設定する必要があります。

コンタクトのインタラクションを取得するには:

Visual StudioのSolution Explorerで、Program.csファイルをダブルクリックし、内容を次のコードで置き換えます。

using Sitecore.XConnect;
using Sitecore.XConnect.Client;
using Sitecore.XConnect.Client.WebApi;
using Sitecore.XConnect.Collection.Model;
using Sitecore.XConnect.Schema;
using Sitecore.Xdb.Common.Web;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace Sitecore.Documentation
{
    public class Program
    {
        // From <xConnect instance>\App_Config\AppSettings.config
        const string CERTIFICATE_OPTIONS = 
            "StoreName=My;StoreLocation=LocalMachine;FindType=FindByThumbprint;FindValue=???";

        // From your installation
        const string XCONNECT_URL = "https://???XConnect.local";

        // From the previous xConnect walkthrough
        const string CONTACT_IDENTIFIER = "myrtlesitecore???";

        private static void Main(string[] args)
        {
            MainAsync(args).ConfigureAwait(false).GetAwaiter().GetResult();
            System.Console.ForegroundColor = ConsoleColor.DarkGreen;
            System.Console.WriteLine("");
            Console.WriteLine("END OF PROGRAM.");
            Console.ReadKey();
        }

        private static async Task MainAsync(string[] args)
        {
            CertificateHttpClientHandlerModifierOptions options = CertificateHttpClientHandlerModifierOptions.Parse(CERTIFICATE_OPTIONS);

            var certificateModifier = new CertificateHttpClientHandlerModifier(options);

            List<IHttpClientModifier> clientModifiers = new List<IHttpClientModifier>();
            var timeoutClientModifier = new TimeoutHttpClientModifier(new TimeSpan(0, 0, 20));
            clientModifiers.Add(timeoutClientModifier);

            var collectionClient = new CollectionWebApiClient(
                new Uri(XCONNECT_URL + "/odata"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var searchClient = new SearchWebApiClient(
                new Uri(XCONNECT_URL + "/odata"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var configurationClient = new ConfigurationWebApiClient(
                new Uri(XCONNECT_URL + "/configuration"),
                clientModifiers,
                new[] { certificateModifier }
            );

            var cfg = new XConnectClientConfiguration(
                new XdbRuntimeModel(CollectionModel.Model),
                collectionClient,
                searchClient,
                configurationClient
            );

            try
            {
                cfg.Initialize();

                // Print xConnect if configuration is valid
                var arr = new[]
                {
                    @"            ______                                                       __     ",
                    @"           /      \                                                     |  \    ",
                    @" __    __ |  $$$$$$\  ______   _______   _______    ______    _______  _| $$_   ",
                    @"|  \  /  \| $$   \$$ /      \ |       \ |       \  /      \  /       \|   $$ \  ",
                    @"\$$\/  $$| $$      |  $$$$$$\| $$$$$$$\| $$$$$$$\|  $$$$$$\|  $$$$$$$ \$$$$$$   ",
                    @" >$$  $$ | $$   __ | $$  | $$| $$  | $$| $$  | $$| $$    $$| $$        | $$ __  ",
                    @" /  $$$$\ | $$__/  \| $$__/ $$| $$  | $$| $$  | $$| $$$$$$$$| $$_____   | $$|  \",
                    @"|  $$ \$$\ \$$    $$ \$$    $$| $$  | $$| $$  | $$ \$$     \ \$$     \   \$$  $$",
                    @" \$$   \$$  \$$$$$$   \$$$$$$  \$$   \$$ \$$   \$$  \$$$$$$$  \$$$$$$$    \$$$$ "
                };
                Console.WindowWidth = 160;
                foreach (string line in arr)
                    Console.WriteLine(line);

            }
            catch (XdbModelConflictException ce)
            {
                Console.WriteLine("ERROR:" + ce.Message);
                return;
            }

            // Initialize a client using the validated configuration
            using (var client = new XConnectClient(cfg))
            {
                try
                {
                    // Get a known contact
                    IdentifiedContactReference reference = new IdentifiedContactReference(
                        "twitter",
                        CONTACT_IDENTIFIER
                    );

                    Contact existingContact = await client.GetAsync<Contact>(
                        reference,
                        new ContactExpandOptions(new string[] {  
                            PersonalInformation.DefaultFacetKey
                        })
                        {
                            Interactions = new RelatedInteractionsExpandOptions(IpInfo.DefaultFacetKey)
                            {
                                StartDateTime = DateTime.MinValue,
                                EndDateTime = DateTime.MaxValue
                            }
                        }
                    );

                    if (existingContact != null)
                    {
                        PersonalInformation existingContactFacet = existingContact.GetFacet<PersonalInformation>(PersonalInformation.DefaultFacetKey);

                        Console.WriteLine("Contact ID: " + existingContact.Id.ToString());
                        Console.WriteLine("Contact Name: " + existingContactFacet.FirstName);

                        var interactions = existingContact.Interactions;
                        var i = 0;

                        Console.WriteLine("Interaction count: " + interactions.Count);
                        Console.WriteLine("");

                        // Cycle through all interactions
                        foreach (var interaction in interactions)
                        {
                            i++;
                            var ipInfo = interaction.GetFacet<IpInfo>(IpInfo.DefaultFacetKey);
                            Console.WriteLine("Interaction #" + i);

                            if (ipInfo != null)
                            {
                                // For each interaction, print out the business name
                                // associated with that interaction's IpInfo
                                Console.WriteLine("Interaction business name: " + ipInfo.BusinessName);
                            }
                        }

                        Console.ReadLine();
                    }

                    Console.ReadLine();
                }                
                catch (XdbExecutionException ex)
                {
                    // Deal with exception
                }
            }
        }
    }
}

CERTIFICATE_THUMBPRINT、XCONNECT_URL、およびCONTACT IDENTIFIER定数を編集します。
Program.csファイルを保存します。
F5キーを押してアプリを実行します。接続が確立されると、アプリはターミナルに次のように書き込みます。
- 連絡先ID。
- 連絡先の名前。
- インタラクションの数。
- 各インタラクションのビジネス名。

先端

StartDateTimeプロパティとEndDateTimeプロパティを調整して、これら2つの時点間の相互作用のみを取得できます。
Limitプロパティは、表示するインタラクションの数に設定できます (最初のインタラクションから数えます)。

インタラクションを取得する

インタラクションを取得するには、コンタクトIDとインタラクションIDが必要です。また、関連する連絡先と指定した連絡先ファセットを取得するInteractionExpandOptionsを渡すこともできます。

インタラクションを取得するには、次のコードを使用します。

var contactId = Guid.NewGuid();
var interactionId = Guid.NewGuid();

InteractionReference interactionReference = new InteractionReference(contactId, interactionId);

Interaction interaction = client.Get<Interaction>(
    interactionReference,
    new InteractionExpandOptions(new string[] { IpInfo.DefaultFacetKey })
    {
        Contact = new RelatedContactExpandOptions(new string[] { 
            PersonalInformation.DefaultFacetKey
        })
    }
);

次のチュートリアルに進み、連絡先と対話を検索する方法を学習します。

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