ClientLink データ オブジェクト - Customer Management
クライアント リンク オブジェクトを定義します。 クライアント リンク招待を承諾すると、代理店は対応するクライアント広告主アカウントを管理できます。 クライアント広告主アカウントを管理するための招待を送信するには、 AddClientLinks 操作を呼び出し、管理するアカウントごとに 1 つのクライアント リンクを指定します。
クライアント リンクにパブリック システム識別子がありません。 個別のクライアント リンクは、 ClientEntityId と ManageingCustomerId によって識別できます。
ヒント
クライアント リンク ライフサイクルの詳細については、 アカウント階層 のテクニカル ガイドを参照してください。 代理店になる方法の詳細については、代理店 パートナー向けのリソースに関するページを参照してください。 クライアントの観点から詳しくは、「 Microsoft Advertising アカウントを代理店で管理する方法」をご覧ください。
注:
クライアントの代理でアカウントを作成するパイロット (GetCustomerPilotFeatures が 793 を返す) の代理店のお客様は、 SignupCustomer サービス操作を介して広告アカウント レベルのクライアント リンクを確立することもできます。 詳細については、「 SignupCustomer 」を参照してください。
構文
<xs:complexType name="ClientLink" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ClientEntityId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="ClientEntityNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ClientEntityName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ManagingCustomerId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="ManagingCustomerNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ManagingCustomerName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Note" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="InviterEmail" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="InviterName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="InviterPhone" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsBillToClient" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Status" nillable="true" type="tns:ClientLinkStatus" />
<xs:element minOccurs="0" name="SuppressNotification" type="xs:boolean" />
<xs:element minOccurs="0" name="LastModifiedDateTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="LastModifiedByUserId" type="xs:long" />
<xs:element minOccurs="0" name="Timestamp" nillable="true" type="xs:base64Binary" />
<xs:element xmlns:q10="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q10:ArrayOfKeyValuePairOfstringstring" />
<xs:element minOccurs="0" name="CustomerLinkPermission" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
要素
ClientLink オブジェクトには、ClientEntityId、ClientEntityName、ClientEntityNumber、CustomerLinkPermission、ForwardCompatibilityMap、InviterEmail、InviterName、InviterPhone、IsBillToClient、LastModifiedByUserId、LastModifiedDateTime、ManageingCustomerId、ManageingCustomerName、ManageingCustomerName、ManageingCustomerNumber、、 Name、Note、StartDate、Status、SuppressNotification、Timestamp、Type。
要素 | 説明 | データ型 |
---|---|---|
ClientEntityId | 管理するクライアント広告主アカウントまたはクライアント顧客の識別子 Type 要素は、リンクがクライアント広告主アカウントかクライアント顧客かを決定します。 足す: 必須。 ClientEntityId または ClientEntityNumber が必要ですが、両方を指定すると操作が失敗します。 更新: 読み取り専用と必須。 |
long |
ClientEntityName | 管理するクライアント広告主アカウントまたはクライアント顧客の名前 Type 要素は、リンクがクライアント広告主アカウントかクライアント顧客かを決定します。 足す: 読み取り専用 更新: 読み取り専用 |
string |
ClientEntityNumber | 管理するクライアント広告主アカウントまたはクライアント顧客の数 Type 要素は、リンクがクライアント広告主アカウントかクライアント顧客かを決定します。 足す: 必須。 ClientEntityId または ClientEntityNumber が必要ですが、両方を指定すると操作が失敗します。 更新: 読み取り専用と必須。 |
string |
CustomerLinkPermission | ユーザーのアカウントへのアクセスが顧客階層 (顧客レベルのクライアント リンク) によって制限されているかどうかを判断します。 この要素は、 Type が CustomerLink に設定されている場合にのみ適用されます。 その場合、使用可能な値には管理と標準が含まれます。 それ以外の場合、このフィールドは nil または空にする必要があります。 このフィールドが "管理" に設定されている場合、ユーザーは管理顧客リンクを介して ClientEntityId にアクセス できます。 このフィールドが "Standard" に設定されている場合、ユーザーは Standard 顧客リンクを介して ClientEntityId にアクセス できます。 ClientEntityId は顧客リンク階層の一部であり、ユーザーはその下の他の顧客にアクセスできます。 詳細については、 ユーザー ロール のテクニカル ガイドを参照してください。 足す: 随意 更新: 読み取り専用 |
string |
ForwardCompatibilityMap | 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、 ClientLink オブジェクトの前方互換性の変更はありません。 |
KeyValuePairOfstring 配列 |
InviterEmail | クライアント リンク要求を作成したユーザーの電子メール。 この値は、現在認証されているユーザーの Microsoft Advertising に既に保存されている電子メールと同じである必要も、変更に使用される必要もありません。 指定しない場合、サービスは、現在認証されているユーザーの Microsoft Advertising に既に保存されているメールにこの値を設定します。 足す: 随意 更新: 読み取り専用 |
string |
InviterName | クライアント リンク要求を作成したユーザーの親顧客の名前。 この値は、Microsoft Advertising に既に格納されている顧客名と同じである必要も、変更に使用される必要もありません。 指定しない場合、サービスは、現在認証されているユーザーの Microsoft Advertising に既に格納されている親顧客名にこの値を設定します。 足す: 随意 更新: 読み取り専用 |
string |
InviterPhone | クライアント リンク要求を作成したユーザーの電話番号。 この値は、現在認証されているユーザーの Microsoft Advertising に既に格納されている電話番号と同じである必要も、変更に使用される必要もありません。 指定しない場合、サービスは、現在認証されているユーザーの Microsoft Advertising に既に格納されている電話番号にこの値を設定します。 足す: 随意 更新: 読み取り専用 |
string |
IsBillToClient | クライアント広告主アカウントの所有者または管理顧客が課金支払いを担当するかどうかを決定します。 この要素は広告主アカウントのクライアント リンクにのみ適用され、顧客リンクには適用されません。 クライアント広告主アカウントは、後払い請求用に設定する必要があります。 前払いアカウントは、代理店による管理ではサポートされていません。 true に設定されている場合、クライアントは課金を担当します。 false に設定した場合、管理する顧客は課金を担当します。 足す: 広告主アカウントのリンクに必要です。顧客リンクには適用されません。 更新: 読み取り専用 |
boolean |
LastModifiedByUserId | クライアント リンクの情報を更新する最後のユーザーの識別子。 足す: 読み取り専用 更新: 読み取り専用 |
long |
LastModifiedDateTime | クライアント リンクが最後に更新された日時。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。 足す: 読み取り専用 更新: 読み取り専用 |
dateTime |
ManageingCustomerId | クライアント広告主アカウントの管理または管理を要求している顧客の識別子。 足す: 必須。 ManageingCustomerId または ManageingCustomerNumber が必要ですが、両方を指定すると操作が失敗します。 更新: 読み取り専用と必須 |
long |
ManageingCustomerName | クライアント広告主アカウントの管理または管理を要求している顧客の名前。 足す: 読み取り専用 更新: 読み取り専用 |
string |
ManageingCustomerNumber | クライアント広告主アカウントの管理または管理を要求している顧客の数。 足す: 必須。 ManageingCustomerId または ManageingCustomerNumber が必要ですが、両方を指定すると操作が失敗します。 更新: 読み取り専用と必須 |
string |
名前 | このクライアント リンクを参照するために使用できるフレンドリ名。 名前には、最大 40 文字を含めることができます。 何も指定されていない場合は、既定の名前が指定されます。 ユーザーの他のクライアント リンクと比較して、名前を一意にする必要はありません。 足す: 随意 更新: 読み取り専用 |
string |
注: | クライアント リンクの招待に関するコンテキストと詳細を提供する要求元からの省略可能なメッセージ。 足す: 随意 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
string |
StartDate | 状態が更新される日付。 受け入れられたリンク要求の場合、状態はこの日付に [アクティブ] に切り替わります。リンク解除要求の場合、状態はこの日付で [非アクティブ] に遷移します。 指定しない場合、この値は現在の日付と時刻に設定されます。 足す: 随意 更新: 読み取り専用 |
dateTime |
Status | クライアント リンクが受け入れられたか拒否されたかなど、クライアント リンクのライフ サイクルの状態を決定します。 クライアント リンクを追加する場合、この要素を指定できず、サービスによって有効な状態が LinkPending に設定されます。 足す: 読み取り専用 更新: 必須 |
ClientLinkStatus |
SuppressNotification | クライアント 広告主アカウントのプライマリ ユーザーにクライアント リンク招待の電子メール通知を送信するかどうかを指定します。 true に設定すると、クライアントは電子メールを受信しません。それ以外の場合、既定値は false であるため、クライアントは電子メール通知を受け取ります。 足す: 随意 更新: 読み取り専用 |
boolean |
Timestamp | 将来使用するために予約されています。 | base64Binary |
種類 | リンクがクライアント広告主アカウントかクライアント顧客かを決定します。 使用できる値は AccountLink と CustomerLink です。 この要素が空の場合、または AccountLink に設定されている場合、 ClientEntityId、 ClientEntityName、および ClientEntityNumber は、クライアント広告主アカウントを表します。 この要素が CustomerLink に設定されている場合、 ClientEntityId、 ClientEntityName、および ClientEntityNumber はクライアント顧客を表します。 足す: 随意。 この要素が設定されていない場合、サービスは広告主アカウントクライアントリンクの作成を試みます。 更新: 読み取り専用 |
string |
要件
サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities