Export (0) Print
Expand All

ClientLink Data Object

System_CLiX_note Note

This feature is not supported in sandbox.

Defines a client link object. Acceptance of a client link invitation enables an agency to manage the corresponding client accounts. To send an invitation to manage a client account, call the AddClientLinks operation and specify one client link per account to manage. For more information about the client link lifecycle, see Link to Client Accounts.

System_CLiX_note Note

This object does not have a system defined identifier. To uniquely identify a client link, use either the ClientAccountId or ClientAccountNumber paired with either the ManagingCustomerId or ManagingCustomerNumber.


<xs:complexType name="ClientLink">
  <xs:sequence>
    <xs:element name="ClientAccountId" type="xs:int" nillable="true" minOccurs="0"/>
    <xs:element name="ClientAccountNumber" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="ManagingCustomerId" type="xs:int" nillable="true" minOccurs="0"/>
    <xs:element name="ManagingCustomerNumber" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="Note" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="Name" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="InviterEmail" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="InviterName" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="InviterPhone" type="xs:string" nillable="true" minOccurs="0"/>
    <xs:element name="IsBillToClient" type="xs:boolean" minOccurs="0"/>
    <xs:element name="StartDate" type="xs:dateTime" nillable="true" minOccurs="0"/>
    <xs:element name="Status" type="tns:ClientLinkStatus" nillable="true" minOccurs="0"/>
    <xs:element name="SuppressNotification" type="xs:boolean" minOccurs="0"/>
    <xs:element name="LastModifiedDateTime" type="xs:dateTime" minOccurs="0"/>
    <xs:element name="LastModifiedByUserId" type="xs:int" minOccurs="0"/>
    <xs:element name="Timestamp" type="xs:base64Binary" nillable="true" minOccurs="0"/>
    <xs:element name="ForwardCompatibilityMap" type="q4:ArrayOfKeyValuePairOfstringstring" nillable="true" minOccurs="0" xmlns:q4="http://schemas.datacontract.org/2004/07/System.Collections.Generic"/>
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

ClientAccountId

The identifier of the client account to manage.

When adding a client link, either the ClientAccountId or ClientAccountNumber is required, but specifying both will cause the operation to fail.

long

Optional

Read-only and Required

ClientAccountNumber

The number of the client account to manage.

When adding a client link, either the ClientAccountId or ClientAccountNumber is required, but specifying both will cause the operation to fail.

string

Optional

Read-only and Required

ForwardCompatibilityMap

The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

System_CLiX_noteNote

Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the ClientLink object.

KeyValuePairOfstringstring array

Read-only

Read-only

IsBillToClient

Determines whether the owner of the client account or the managing customer is responsible for billing payments.

If set to true the client will be responsible and otherwise, since the default value is false, the managing customer is responsible for billing.

boolean

Optional

Read-only

InviterEmail

The email of the user who created the client link request.

This value does not need to be the same as, nor is it used to modify, the email already stored in Bing Ads for the current authenticated user.

If not specified, the service will set this value to the email already stored in Bing Ads for the current authenticated user.

string

Optional

Read-only

InviterName

The name of the parent customer of the user who created the client link request.

This value does not need to be the same as, nor is it used to modify, the customer name already stored in Bing Ads.

If not specified, the service will set this value to the parent customer name already stored in Bing Ads for the current authenticated user.

string

Optional

Read-only

InviterPhone

The phone number of the user who created the client link request.

This value does not need to be the same as, nor is it used to modify, the phone number already stored in Bing Ads for the current authenticated user.

If not specified, the service will set this value to the phone number already stored in Bing Ads for the current authenticated user.

string

Optional

Read-only

LastModifiedByUserId

The identifier of the last user to update the client link’s information.

long

Read-only

Read-only

LastModifiedDateTime

The date and time that the client link was last updated. The value is in Coordinated Universal Time (UTC).

System_CLiX_noteNote

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

dateTime

Read-only

Read-only

ManagingCustomerId

The identifier of the customer who manages or is requesting to manage the client account.

When adding a client link, either the ManagingCustomerId or ManagingCustomerNumber is required, but specifying both will cause the operation to fail.

long

Optional

Read-only and Required

ManagingCustomerNumber

The number of the customer who manages or is requesting to manage the client account.

When adding a client link, either the ManagingCustomerId or ManagingCustomerNumber is required, but specifying both will cause the operation to fail.

string

Optional

Read-only and Required

Name

The friendly name that can be used to reference this client link.

The name can contain a maximum of 40 characters.

A default name will be provided if none is specified. The name does not need to be unique compared to other client links for the user.

string

Optional

Read-only

Note

Optional message from the requestor providing context and details about the client link invitation.

string

Optional

Optional

StartDate

The date when the status would update. For an accepted link request the status would transition towards Active on this date, and for an unlink request the status would transition towards Inactive on this date.

If not specified, this value will be set to the current date and time.

dateTime

Optional

Read-only

Status

Determines the life cycle status of the client link, for example whether the client link has been accepted or declined.

When adding a client link this element cannot be specified, and the service sets the effective status to LinkPending.

ClientLinkStatus

Read-only

Required

SuppressNotification

Determines whether or not to send email notification of the client link invitation to the primary user of the client account.

If set to true the client will not receive an email and otherwise, since the default value is false, the client will receive an email notification.

boolean

Optional

Read-only

TimeStamp

The time-stamp value that the system uses internally to reconcile updates when you call the UpdateClientLinks operation.

base64Binary

Read-only

Required

Requirements

CustomerManagementService.svc v9

Namespace: https://bingads.microsoft.com/Customer/v9

Community Additions

ADD
Show:
© 2014 Microsoft