リマーケティング リスト データ オブジェクト - キャンペーン管理
リマーケティング リストを定義します。
ヒント
実装の概要については、 ユニバーサル イベント追跡 技術ガイドを参照してください。
注:
Microsoft 広告では、ユーザーがパイロット参加者である場合、リマーケティング リストの類似ユーザーが自動的に生成されます。 リマーケティング リストの類似ユーザーを作成または編集することはできません。 そうは言っても、類似のリマーケティング リストの関連付けと除外を追加および削除できます。 ソース リマーケティング リストを削除すると、同様の対象ユーザーも削除されます。 同様の対象ユーザーがキャンペーンまたは広告グループに関連付けられている場合、ソース リマーケティング リストを削除することはできません。 詳細については、「 SimilarRemarketingList 」を参照してください。
構文
<xs:complexType name="RemarketingList" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:Audience">
<xs:sequence>
<xs:element minOccurs="0" name="Rule" nillable="true" type="tns:RemarketingRule" />
<xs:element minOccurs="0" name="TagId" nillable="true" type="xs:long" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
要素
リマーケティング リスト オブジェクトには、Rule、TagId という要素があります。
| 要素 | 説明 | データ型 |
|---|---|---|
| Rule | ルールには、リマーケティング リストに追加するユーザーを決定するために使用される条件が含まれます。 さまざまな対象ユーザーを対象とする 4 種類のルールのいずれかを選択できます。 CustomEventsRule、 PageVisitorsRule、 PageVisitorsWhoDidNotVisitAnotherPageRule、 PageVisitorsWhoVisitedAnotherPageRule です。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 前のルール項目のいずれかを保持する場合は、更新中に明示的に再度設定する必要があります。 更新中にルールの種類を変更することもできます。 |
RemarketingRule |
| TagId | リマーケティング リストで使用されるユニバーサル イベント トラッキング (UET) タグの Microsoft Advertising 識別子。 タグ ID に依存する前に、UET タグを別の顧客と共有することも、他の顧客から共有することもできます。 共有 UET タグと対象ユーザーは、パイロットのお客様のみが使用できます。 顧客階層での対象ユーザーと UET タグの共有の概要については、「 対象ユーザーと UET タグの共有 」テクニカル ガイドを参照してください。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
long |
リマーケティング リスト オブジェクトには継承された要素があります。
継承された要素
対象ユーザーから継承された要素
リマーケティング リスト オブジェクトは Audience オブジェクトから派生し、AudienceNetworkSize、CustomerShare、Description、ForwardCompatibilityMap、Id、MembershipDuration、Name、ParentId、Scope、SearchSize、SupportedCampaignTypes、Type という要素を継承します。 以下の説明は リマーケティング リストに固有であり、 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 日で、許可される最大期間は 180 日です。 追加： オプション。 指定しない場合、メンバーシップ期間は既定で 30 に設定されます。 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
int |
| 名前 | 対象ユーザーの名前。 名前には最大 128 文字を使用することができます。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
string |
| ParentId | アカウントまたは顧客の Microsoft Advertising 識別子。 [スコープ] が [アカウント] に設定されている場合、これはアカウント ID、それ以外の場合は顧客 ID です。 追加： 必須 更新： 読み 取り 専用。 親 ID は変更できません。 |
long |
| 範囲 | スコープは、この対象ユーザーを使用できるアカウントを定義します。 スコープが [アカウント] に設定されている場合、対象ユーザーは、1 つのアカウントのキャンペーンと広告グループにのみ関連付けることができます。つまり、 ParentId を使用します。 スコープが [顧客] に設定されている場合、対象ユーザーは、顧客のすべてのアカウントのキャンペーンと広告グループに関連付けることができます。 追加： 必須 更新： オプション。 スコープを [アカウント] から [顧客] に変更できますが、スコープを [顧客] から [アカウント] に変更することはできません。 |
EntityScope |
| SearchSize | 検索ネットワーク内のこの対象ユーザーのアクティブ メンバーであるユーザーの合計数。 これにより、ターゲットにできる検索ユーザーの数を把握できます。 Microsoft Advertising が最適化に使用する前に、対象ユーザーは少なくとも 300 人である必要があります。 リマーケティング リストのメンバーシップ期間、ルール、タグ識別子を追加または更新する場合など、対象ユーザーが作成されている間、このプロパティは最大 24 時間空になります。 リマーケティング リストに関連付けられている UET タグの状態が [未確認] または [非アクティブ] の場合、リストを作成するために必要なユーザー情報を Web サイトから受け取ることができないため、このプロパティは無効になります。 追加： 読み 取り 専用 更新： 読み 取り 専用 |
long |
| SupportedCampaignTypes | この対象ユーザーをサポートするキャンペーンの種類の一覧。 サポートされる値は、対象ユーザー、DynamicSearchAds、検索、ショッピングです。 今後、新しいキャンペーンの種類が追加される可能性があるため、固定の値セットに依存しないようにしてください。 追加： 読み 取り 専用 更新： 読み 取り 専用 |
string 配列 |
| 型 | 対象ユーザーの種類。 この値は、 リマーケティング リストの 対象ユーザーを取得する場合のリマーケティング リストです。 対象ユーザーの種類の詳細については、「 対象ユーザー データ オブジェクトの備考」を参照してください。 追加： 読み 取り 専用 更新： 読み 取り 専用 |
AudienceType |
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13