対象ユーザー データ オブジェクト - キャンペーン管理
対象ユーザーの基本オブジェクトを定義します。
対象ユーザーをインスタンス化しないでください。 次のオブジェクトから派生する 1 つ以上のオブジェクトを作成できます。
注:
Microsoft Advertising では、パイロット参加者向けのリマーケティング リストの類似ユーザーが自動的に生成されます。つまり、 GetCustomerPilotFeatures は機能識別子 317 を返します。
構文
<xs:complexType name="Audience" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="AudienceNetworkSize" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="CustomerShare" nillable="true" type="tns:CustomerShare" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element xmlns:q123="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q123:ArrayOfKeyValuePairOfstringstring" />
<xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="MembershipDuration" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ParentId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="Scope" nillable="true" type="tns:EntityScope" />
<xs:element minOccurs="0" name="SearchSize" nillable="true" type="xs:long" />
<xs:element xmlns:q124="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="SupportedCampaignTypes" nillable="true" type="q124:ArrayOfstring" />
<xs:element minOccurs="0" name="Type" type="tns:AudienceType" />
</xs:sequence>
</xs:complexType>
要素
Audience オブジェクトには、AudienceNetworkSize、CustomerShare、Description、ForwardCompatibilityMap、Id、MembershipDuration、Name、ParentId、Scope、SearchSize、SupportedCampaignTypes、Type という要素があります。
| 要素 | 説明 | データ型 |
|---|---|---|
| AudienceNetworkSize | 対象ユーザー ネットワーク内のこの対象ユーザーのアクティブ メンバーであるユーザーの合計数。 これにより、対象となる対象ユーザーの数を把握できます。 この要素を継承するオブジェクト ( リマーケティング リストなど) の詳細については、ドキュメントを参照してください。 |
long |
| CustomerShare | 対象ユーザーを共有する顧客とアカウントの一覧を決定します。 詳細には、対象ユーザーの関連付け数が含まれます。 この要素は 、リマーケティング リストでのみサポートされます。 他の種類の対象ユーザーを顧客階層内で共有することはできません。 |
CustomerShare |
| 説明 | 対象ユーザーの説明。 説明を使用して、ターゲットとする対象ユーザーを思い出すのに役立ちます。 説明には、最大 1,024 文字を含めることができます。 |
string |
| ForwardCompatibilityMap | 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、このオブジェクトの前方互換性の変更はありません。 |
KeyValuePairOfstring 配列 |
| Id | 対象ユーザーの Microsoft Advertising 識別子。 | long |
| MembershipDuration | 対象ユーザーを作成するときに、Microsoft Advertising が対象ユーザーの定義に一致するアクションを検索する必要がある時間を、どの程度前から検索するかを指定できます。 最小期間は 1 日で、許可される最大期間は 180 日です。 |
int |
| 名前 | 対象ユーザーの名前。 名前には最大 128 文字を使用することができます。 | string |
| ParentId | アカウントまたは顧客の Microsoft Advertising 識別子。 [スコープ] が [アカウント] に設定されている場合、これはアカウント ID、それ以外の場合は顧客 ID です。 |
long |
| 範囲 | スコープは、この対象ユーザーを使用できるアカウントを定義します。 スコープが [アカウント] に設定されている場合、対象ユーザーは、1 つのアカウントのキャンペーンと広告グループにのみ関連付けることができます。つまり、 ParentId を使用します。 スコープが [顧客] に設定されている場合、対象ユーザーは、顧客のすべてのアカウントのキャンペーンと広告グループに関連付けることができます。 |
EntityScope |
| SearchSize | 検索ネットワーク内のこの対象ユーザーのアクティブ メンバーであるユーザーの合計数。 これにより、ターゲットにできる検索ユーザーの数を把握できます。 この要素を継承するオブジェクト ( リマーケティング リストなど) の詳細については、ドキュメントを参照してください。 |
long |
| SupportedCampaignTypes | この対象ユーザーをサポートするキャンペーンの種類の一覧。 サポートされる値は、対象ユーザー、DynamicSearchAds、検索、ショッピングです。 今後、新しいキャンペーンの種類が追加される可能性があるため、固定の値セットに依存しないようにしてください。 |
string 配列 |
| 型 | 対象ユーザーの種類。 対象ユーザーの種類の詳細については、「 備考」を参照してください。 | AudienceType |
注釈
Java および .NET 言語の場合は、カスタム対象ユーザーと別の種類の対象ユーザーのどちらをインスタンス化するかによって値が決定されるため、 Type 要素を設定しないでください。 SOAP を手動で生成する場合は、次の例に示すように、Audience ノードの type 属性を使用します。
<Audiences xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Audience i:type="CustomAudience">
<Description i:nil="false">Custom Audience Description</Description>
<ForwardCompatibilityMap xmlns:e43="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e43:KeyValuePairOfstringstring>
<e43:key i:nil="false"></e43:key>
<e43:value i:nil="false"></e43:value>
</e43:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id i:nil="true" />
<MembershipDuration i:nil="false">30</MembershipDuration>
<Name i:nil="false">Custom Audience Name</Name>
<ParentId i:nil="false">ParentIdHere</ParentId>
<Scope>Customer</Scope>
</Audience>
</Audiences>
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13