Search連絡先

識別子ソースによる連絡先をSearch

以下の例は、Sourceプロパティの値がtwitterとなるすべての識別子を持つすべてのコンタクトを取得する方法を示しています。結果は10個ずつのバッチで返されます。各コンタクトに対して、元のtweeterを含む新しい識別子が追加され、古い識別子は削除されます(識別子は編集できません)。操作は約200件のバッチでxConnectに提出されます。

using System.Collections.Generic; using System.Linq; using Sitecore.XConnect; using Sitecore.XConnect.Client;

namespace Documentation { public class SearchBySource { public async void ExampleAsync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { IAsyncQueryable<Sitecore.XConnect.Contact> query = client.Contacts.Where(c => c.Identifiers.Any(s => s.Source == "twitter"));

var enumerator = await query.GetBatchEnumerator(10); int counter = 0;

// Cycle through batches while (await enumerator.MoveNext()) { counter = counter + enumerator.Current.Count;

// Cycle through batch of 10 foreach (var contact in enumerator.Current) { var twitterIdentifiers = contact.Identifiers.Where(x => x.Source == "twitter");

foreach (var identifier in twitterIdentifiers) { // Create new identifier where 'twitter' is replaced by 'tweeter' var newIdentifier = new ContactIdentifier("tweeter", identifier.Identifier, ContactIdentifierType.Known);

// Add new identifier client.AddContactIdentifier(contact, newIdentifier);

// Remove old identifier client.RemoveContactIdentifier(contact, identifier); } }

if (counter == 100) { // Submit batch of approximately 200 operations (two operations per contact), reset counter // Some contacts might have more than one matching identifier await client.SubmitAsync(); counter = 0; } } } catch (XdbExecutionException ex) { // Handle exception } } } public void ExampleSync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var enumerator = client.Contacts.Where(c => c.Identifiers.Any(s => s.Source == "twitter")).GetBatchEnumeratorSync(10);

int counter = 0;

// Cycle through batches while (enumerator.MoveNext()) { counter = counter + enumerator.Current.Count;

// Cycle through batch of 10 foreach (var contact in enumerator.Current) { var twitterIdentifiers = contact.Identifiers.Where(x => x.Source == "twitter");

foreach (var identifier in twitterIdentifiers) { // Create new identifier where 'twitter' is replaced by 'tweeter' var newIdentifier = new ContactIdentifier("tweeter", identifier.Identifier, ContactIdentifierType.Known);

// Add new identifier client.AddContactIdentifier(contact, newIdentifier);

// Remove old identifier client.RemoveContactIdentifier(contact, identifier); } }

if (counter == 100) { // Submit batch of approximately 200 operations (two operations per contact), reset counter // Some contacts might have more than one matching identifier client.Submit(); counter = 0; } } } catch (XdbExecutionException ex) { // Handle exception } } } } }

識別子タイプによるSearch Contact

以下の例では、少なくとも1つの既知の識別子を持つすべての接触が返されます。

using System.Collections.Generic; using System.Linq; using Sitecore.XConnect; using Sitecore.XConnect.Client;

namespace Documentation { public class SearchByContactIdentifierType { public async void ExampleAsync() { using (XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var queryable = client.Contacts.Where(x => x.Identifiers.Any(i => i.IdentifierType == ContactIdentifierType.Known)).GetBatchEnumerator(10); // Get the first 10 results

var enumerator = await queryable;

// Total count of contacts (all batches) var totalContacts = enumerator.TotalCount;

// Cycle through batches while (await enumerator.MoveNext()) { // Cycle through batch of 10 foreach (var contact in enumerator.Current) { // Do something with contact } }

} catch (XdbExecutionException ex) { // Handle exception } } }

public void ExampleSync() { using (XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var enumerator = client.Contacts.Where(x => x.Identifiers.Any(i => i.IdentifierType == ContactIdentifierType.Known)).GetBatchEnumeratorSync(10); // Get the first 10 results

// Total count of contacts (all batches) var totalContacts = enumerator.TotalCount;

// Cycle through batches while (enumerator.MoveNext()) { // Cycle through batch of 10 foreach (var contact in enumerator.Current) { // Do something with contact } }

} catch (XdbExecutionException ex) { // Handle exception } } }

} }

Search by Contact facetの存在

ヌル値の検索は不可能です。面が設定されているかどうかを判断するために、値を持ちやすい性質を探すべきです。例えば:

• EmailAddressListクラスの構成者に希望するメールアドレスを渡す必要があります。したがって、入力されているPreferredEmail.SmtpAddressプロパティに頼ることができます。
• PersonalInformationクラスには必須のプロパティはありません。したがって、設定されている可能性が最も高いプロパティを確認する必要があります。

以下の例では、EmailAddressListおよびPersonalInformation面を含むすべての連絡が返されます。この例は、連絡先の名前(PII機密データ)を検索できることに依存しています。

using Sitecore.XConnect.Collection.Model; using System; using System.Collections.Generic; using System.Linq; using Sitecore.XConnect; using Sitecore.XConnect.Client;

namespace Documentation { public class SearchByFacetExists { public async void ExampleAsync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { IAsyncQueryable<Sitecore.XConnect.Contact> queryable = client.Contacts .Where(c => c.GetFacet(PersonalInformation.DefaultFacetKey).FirstName != string.Empty && c.GetFacet(EmailAddressList.DefaultFacetKey).PreferredEmail.SmtpAddress != string.Empty) .WithExpandOptions(new ContactExpandOptions(PersonalInformation.DefaultFacetKey));

var enumerator = await queryable.GetBatchEnumerator(10);

while (await enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { var name = contact.Personal().JobTitle; // Should be 'Programmer Writer' } } } catch (XdbExecutionException ex) { // Handle exception } } }

public void ExampleSync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { IAsyncQueryable<Sitecore.XConnect.Contact> queryable = client.Contacts .Where(c => c.GetFacet(PersonalInformation.DefaultFacetKey).FirstName != string.Empty && c.GetFacet(EmailAddressList.DefaultFacetKey).PreferredEmail.SmtpAddress != string.Empty) .WithExpandOptions(new ContactExpandOptions(PersonalInformation.DefaultFacetKey));

var enumerator = queryable.GetBatchEnumeratorSync(10);

while (enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { var name = contact.Personal().JobTitle; // Should be 'Programmer Writer' } } } catch (XdbExecutionException ex) { // Handle exception } } } } }

Search by nested facetプロパティ値

以下の例は、ブリストルに住所を持つすべての連絡先を返します。展開オプションを使ってAddressList面に結果を返します。

!注AddressList.Preferred物件とAddressList.Others物件を確認しなければなりません。

using Sitecore.XConnect.Collection.Model; using Sitecore.XConnect; using System.Collections.Generic; using System.Linq; using Sitecore.XConnect.Client;

namespace Documentation { public class SearchByFacetNested { // Async example public async void ExampleAsync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { IAsyncQueryable<Sitecore.XConnect.Contact> queryable = client.Contacts.Where(c => c.GetFacet(AddressList.DefaultFacetKey).Others.Any(a => a.Value.City == "Bristol") || c.GetFacet(AddressList.DefaultFacetKey).PreferredAddress.City == "Bristol") .WithExpandOptions(new ContactExpandOptions(AddressList.DefaultFacetKey));

var enumerator = await queryable.GetBatchEnumerator(10);

while (await enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Check primary address var address = contact.Facets.OfType().Select(x => x.PreferredAddress).FirstOrDefault(f => f.City == "Bristol");

// Check other addresses if (address == null) { address = contact.GetFacet(AddressList.DefaultFacetKey).Others.FirstOrDefault(x => x.Value.City == "Bristol").Value; } } } } catch (XdbExecutionException ex) { // Handle exception } } }

// Sync example public void ExampleSync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { IAsyncQueryable<Sitecore.XConnect.Contact> queryable = client.Contacts.Where(c => c.GetFacet(AddressList.DefaultFacetKey).Others.Any(a => a.Value.City == "Bristol") || c.GetFacet(AddressList.DefaultFacetKey).PreferredAddress.City == "Bristol") .WithExpandOptions(new ContactExpandOptions(AddressList.DefaultFacetKey));

var enumerator = queryable.GetBatchEnumeratorSync(10);

while (enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Check primary address var address = contact.Facets.OfType().Select(x => x.PreferredAddress).FirstOrDefault(f => f.City == "Bristol");

// Check other addresses if (address == null) { address = contact.GetFacet(AddressList.DefaultFacetKey).Others.FirstOrDefault(x => x.Value.City == "Bristol").Value; } } } } catch (XdbExecutionException ex) { // Handle exception } } } } }

ファセット拡張法の使用

クエリの文脈でファセット拡張メソッドを使うことができます。以下の例は、.GetFacetメソッドと.Addresses()メソッドを使ってAddressListファセットを取得する方法を示しています。

// Without extension method contact.GetFacet(AddressList.DefaultFacetKey);

// With extension method contact.Addresses();

Search by interaction date(交流日)で

以下の例は、5日を超えるインタラクションを持つコンタクトの取得方法を示しています。さらに、展開オプションを使ってコンタクトの上位20件のインタラクションを返します。これらのインタラクションは必ずしもクエリパラメータと一致しません。

Search by interaction facets

以下の例は、特定のリファラーと相互作用するコンタクトの取得方法を示しています。

Search by interaction events(相互作用イベントによる検索)

以下の例は、以下の条件に合致するイベントを引き起こした連絡先の検索方法を示しています。

• ここでイベントタイプは Goal
• ここでイベント定義IDは {29408b2d-52b6-4f39-96ca-039cd96f4624}

関与措置

以下のクエリは、30秒以上の直近のやり取りがあったすべての連絡先を返します。

using Sitecore.XConnect.Collection.Model; using System; using System.Collections.Generic; using System.Linq; using Sitecore.XConnect; using Sitecore.XConnect.Client;

namespace Documentation { public class SearchEngagementMeasures { // Async example public async void ExampleAsync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var queryable = client.Contacts .Where(x => x.EngagementMeasures().AverageInteractionDuration > new TimeSpan(0, 0, 30)) .WithExpandOptions(new ContactExpandOptions() { Interactions = new RelatedInteractionsExpandOptions() { Limit = 10 } });

var enumerator = await queryable.GetBatchEnumerator(10);

while (await enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Do something with contacts } } } catch (XdbExecutionException ex) { // Handle exception } } }

// Sync example public void ExampleSync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var queryable = client.Contacts .Where(x => x.EngagementMeasures().AverageInteractionDuration > new TimeSpan(0, 0, 30)) .WithExpandOptions(new ContactExpandOptions() { Interactions = new RelatedInteractionsExpandOptions() { Limit = 10 } });

var enumerator = queryable.GetBatchEnumeratorSync(10);

while (enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Do something with contacts } } } catch (XdbExecutionException ex) { // Handle exception } } } } }

キービヘイビアキャッシュ

以下のクエリは、定義ID 951fb783-5959-49a4-a1f3-ced3453725a4の会場で最近行われたすべての接触を返します。

using Sitecore.XConnect.Collection.Model; using System; using System.Linq; using Sitecore.XConnect; using Sitecore.XConnect.Client; using System.Collections.Generic;

namespace Documentation { public class SearchByKeyBehaviorCache { public async void ExampleAsync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var venueId = Guid.Parse("951fb783-5959-49a4-a1f3-ced3453725a4");

IAsyncQueryable queryable = client.Contacts .Where(x => x.KeyBehaviorCache().Venues.Any(v => v.DefinitionId == venueId)) .WithExpandOptions(new ContactExpandOptions() { Interactions = new RelatedInteractionsExpandOptions() { Limit = 1 } });

var enumerator = await queryable.GetBatchEnumerator(10);

while (await enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Do something with contacts } } } catch (XdbExecutionException ex) { // Handle exception } } }

public void ExampleSync() { using (Sitecore.XConnect.Client.XConnectClient client = Sitecore.XConnect.Client.Configuration.SitecoreXConnectClientConfiguration.GetClient()) { try { var venueId = Guid.Parse("951fb783-5959-49a4-a1f3-ced3453725a4");

IAsyncQueryable queryable = client.Contacts .Where(x => x.KeyBehaviorCache().Venues.Any(v => v.DefinitionId == venueId)) .WithExpandOptions(new ContactExpandOptions() { Interactions = new RelatedInteractionsExpandOptions() { Limit = 1 } });

var enumerator = queryable.GetBatchEnumeratorSync(10);

while (enumerator.MoveNext()) { foreach (var contact in enumerator.Current) { // Do something with contacts } } } catch (XdbExecutionException ex) { // Handle exception } } } } }

順番結果

結果はコンタクトのファセットやプロパティによって順序付けることができます。以下の例は、EngagementMeasuresファセットのMostRecentInteractionStartDateTimeプロパティでコンタクトを順序付けする方法を教えています。

IAsyncQueryable<Sitecore.XConnect.Contact> queryable = client.Contacts .Where(x => x.Interactions.Any()) .OrderByDescending(x => x.EngagementMeasures().MostRecentInteractionStartDateTime)

!注リストの性質で並べることはできません。例えば、連絡先のリストをその相互作用のStartDateTimeで並べることはできません。

関連する相互作用はクエリの影響を受けません

以下のクエリは、WebVisitファセットを持つ少なくとも1つのインタラクションを持つすべてのコンタクトを返します。また、コンタクトの上位30回のインタラクションも返します。

client.Contacts.Where(c => c.Interactions.Any(x => x.WebVisit().Browser != null)).WithExpandOptions(new ContactExpandOptions(AddressList.DefaultFacetKey) { Interactions = new RelatedInteractionsExpandOptions(WebVisit.DefaultFacetKey) { Limit = 30 } });

Interactionsコレクションはクエリの影響を受けません。クエリは任意の時点で少なくとも1つの一致する連絡先を持つすべての連絡先を返します。しかし、マッチに至る相互作用が必ずしもすべての連絡先のInteractionsプロパティに存在するわけではありません。