CustomerList データ オブジェクト - キャンペーン管理

CustomerList データ オブジェクトを定義します。

重要

Campaign Management API を使用して顧客リスト データを作成する前に、まず 1 人の顧客リストの対象ユーザーを作成し、Microsoft Advertising UI で使用条件に同意する必要があります。 最初の顧客リストには顧客データを含める必要はありませんが、[同意する] を選択する必要があります。 [同意する] を選択すると (1) ユーザーは、個人データである対象ユーザーの詳細を Microsoft に合法的に開示できることに同意し、(2) カスタマー マッチ条項、Microsoft 広告契約、および Microsoft 広告ポリシーに同意します。 Microsoft は、お客様がアップロードしたデータを カスタマー マッチ条項に従って使用します。

構文

<xs:complexType name="CustomerList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Audience">
      <xs:sequence />
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

要素

CustomerList オブジェクトには継承された要素があります。

継承された要素

対象ユーザーから継承された要素

CustomerList オブジェクトは Audience オブジェクトから派生し、AudienceNetworkSize、CustomerShare、Description、ForwardCompatibilityMap、Id、MembershipDuration、Name、ParentId、Scope、SearchSize、SupportedCampaignTypes、Type という要素を継承します。 以下の説明は CustomerList に固有であり、 Audience オブジェクトから同じ要素を継承する他のオブジェクトには適用されない場合があります。

要素	説明	データ型
AudienceNetworkSize	対象ユーザー ネットワーク内のこの対象ユーザーのアクティブ メンバーであるユーザーの合計数。 これにより、対象となる対象ユーザーの数を把握できます。 Microsoft Advertising が最適化に使用する前に、対象ユーザーは少なくとも 300 人である必要があります。 追加： 読み 取り 専用 更新： 読み 取り 専用	long
CustomerShare	対象ユーザーを共有する顧客とアカウントの一覧を決定します。 詳細には、対象ユーザーの関連付け数が含まれます。 共有 UET タグと対象ユーザーは、パイロットのお客様のみが使用できます。 顧客階層での対象ユーザーと UET タグの共有の概要については、「 対象ユーザーと UET タグの共有 」テクニカル ガイドを参照してください。 追加： オプション 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 既存の顧客アカウント共有を保持するには、この要素を null または空に設定します。 すべての顧客アカウント共有を削除するには、CustomerShare オブジェクトの CustomerAccountShares 要素を null または空に設定します。 顧客アカウント共有のサブセットを削除するには、CustomerShare オブジェクトの CustomerAccountShares 要素に保持する顧客アカウント共有を指定します。	CustomerShare
説明	対象ユーザーの説明。 説明を使用して、ターゲットとする対象ユーザーを思い出すのに役立ちます。 説明には、最大 1,024 文字を含めることができます。 追加： オプション 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	string
ForwardCompatibilityMap	現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、 Audience オブジェクトの前方互換性の変更はありません。	KeyValuePairOfstring 配列
Id	対象ユーザーの Microsoft Advertising 識別子。 追加： 読み 取り 専用 更新： 必須と読み取り専用	long
MembershipDuration	対象ユーザーを作成するときに、Microsoft Advertising が対象ユーザーの定義に一致するアクションを検索する必要がある時間を、どの程度前から検索するかを指定できます。 最小期間は 1 日で、許可される最大期間は 390 日です。 有効期限がない場合は、期間を -1 に設定することもできます。 追加： オプション。 指定しない場合、メンバーシップ期間は既定で 30 に設定されます。 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	int
名前	対象ユーザーの名前。 名前には最大 128 文字を使用することができます。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	string
ParentId	アカウントまたは顧客の Microsoft Advertising 識別子。 [スコープ] が [アカウント] に設定されている場合、これはアカウント ID、それ以外の場合は顧客 ID です。 追加： 必須 更新： 読み 取り 専用。 親 ID は変更できません。	long
範囲	スコープは、この対象ユーザーを使用できるアカウントを定義します。 スコープが [アカウント] に設定されている場合、対象ユーザーは、1 つのアカウントのキャンペーンと広告グループにのみ関連付けることができます。つまり、 ParentId を使用します。 スコープが [顧客] に設定されている場合、対象ユーザーは、顧客のすべてのアカウントのキャンペーンと広告グループに関連付けることができます。 追加： 必須 更新： オプション。 スコープを [アカウント] から [顧客] に変更できますが、スコープを [顧客] から [アカウント] に変更することはできません。	EntityScope
SearchSize	検索ネットワーク内のこの対象ユーザーのアクティブ メンバーであるユーザーの合計数。 これにより、ターゲットにできる検索ユーザーの数を把握できます。 Microsoft Advertising が最適化に使用する前に、対象ユーザーは少なくとも 300 人である必要があります。 顧客リストのメンバーシップ期間を追加または更新する場合など、対象ユーザーが作成されている間、このプロパティは最大 48 時間空または空になります。 追加： 読み 取り 専用 更新： 読み 取り 専用	long
SupportedCampaignTypes	この対象ユーザーをサポートするキャンペーンの種類の一覧。 サポートされる値は、対象ユーザー、DynamicSearchAds、検索、ショッピングです。 今後、新しいキャンペーンの種類が追加される可能性があるため、固定の値セットに依存しないようにしてください。 追加： 読み 取り 専用 更新： 読み 取り 専用	string 配列
型	対象ユーザーの種類。 この値は、 顧客リストの 対象ユーザーを取得するときの CustomerList です。 対象ユーザーの種類の詳細については、「 対象ユーザー データ オブジェクトの備考」を参照してください。 追加： 読み 取り 専用 更新： 読み 取り 専用	AudienceType

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

使用ページ

ApplyCustomerListItems