Compartir a través de

Operación de servicio SearchClientLinks: Administración de clientes

  • Artículo

Busca los vínculos de cliente para el cliente del usuario autenticado actual, filtrados por los criterios de búsqueda. La operación devuelve el vínculo más reciente para cada combinación única de cliente de agencia y cuenta de cliente.

Nota:

Solo un usuario con credenciales super Administración o Standard puede agregar, actualizar y buscar vínculos de cliente a cuentas de anunciantes. Solo un usuario con credenciales de Super Administración puede agregar, actualizar y buscar vínculos de cliente a los clientes. Para obtener más información, consulte la guía técnica Roles de usuario .

Si el usuario está dentro de un cliente cliente que tiene una o varias cuentas administradas por una agencia, puede buscar de una en una las cuentas individuales que eran o son aptas para ser vinculadas. Para buscar por cuenta individual, establezca el campo de predicado en ClientAccountId y establezca el valor del predicado en el identificador de cuenta que desea buscar.

Sugerencia

Para obtener más información sobre el ciclo de vida del vínculo de cliente, consulte la guía técnica Jerarquía de cuentas . Para obtener más información sobre cómo convertirse en una agencia, consulte Recursos para asociados de la agencia. Para obtener más información desde la perspectiva de un cliente, consulte Cómo hacer que una agencia administre su cuenta de Microsoft Advertising.

Elementos Request

El objeto SearchClientLinksRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
Ordenamiento Determina el orden de los resultados.

Este elemento request es opcional. Si se especifica, solo debe incluir un elemento OrderBy en la lista. No se admiten elementos adicionales y el servicio lo omitirá.

Para esta operación de servicio, se admiten los siguientes valores en el elemento Field de un objeto OrderBy .

Id : el orden viene determinado por el elemento ClientAccountId del clientlink devuelto.

Nombre : el orden viene determinado por el elemento Name del clientlink devuelto.

Número : el orden viene determinado por el elemento ManagingCustomerNumber del clientlink devuelto.		 Matriz OrderBy
PageInfo Determina el índice y el tamaño de los resultados por página. Paginación
Predicados Determina las condiciones que se deben cumplir para devolver vínculos de cliente.

Debe incluir uno o dos predicados.

Para obtener más información sobre cómo se determinan los resultados de cada valor de campo de predicado admitido, vea Comentarios del predicado.		 Matriz de predicados

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto SearchClientLinksResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
ClientLinks Lista de invitaciones de vínculo de cliente. Matriz ClientLink

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <Action mustUnderstand="1">SearchClientLinks</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e531="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e531:Predicate>
          <e531:Field i:nil="false">ValueHere</e531:Field>
          <e531:Operator>ValueHere</e531:Operator>
          <e531:Value i:nil="false">ValueHere</e531:Value>
        </e531:Predicate>
      </Predicates>
      <Ordering xmlns:e532="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e532:OrderBy>
          <e532:Field>ValueHere</e532:Field>
          <e532:Order>ValueHere</e532:Order>
        </e532:OrderBy>
      </Ordering>
      <PageInfo xmlns:e533="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e533:Index>ValueHere</e533:Index>
        <e533:Size>ValueHere</e533:Size>
      </PageInfo>
    </SearchClientLinksRequest>
  </s:Body>
</s:Envelope>

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta SOAP.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SearchClientLinksResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <ClientLinks xmlns:e534="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e534:ClientLink>
          <e534:Type d4p1:nil="false">ValueHere</e534:Type>
          <e534:ClientEntityId d4p1:nil="false">ValueHere</e534:ClientEntityId>
          <e534:ClientEntityNumber d4p1:nil="false">ValueHere</e534:ClientEntityNumber>
          <e534:ClientEntityName d4p1:nil="false">ValueHere</e534:ClientEntityName>
          <e534:ManagingCustomerId d4p1:nil="false">ValueHere</e534:ManagingCustomerId>
          <e534:ManagingCustomerNumber d4p1:nil="false">ValueHere</e534:ManagingCustomerNumber>
          <e534:ManagingCustomerName d4p1:nil="false">ValueHere</e534:ManagingCustomerName>
          <e534:Note d4p1:nil="false">ValueHere</e534:Note>
          <e534:Name d4p1:nil="false">ValueHere</e534:Name>
          <e534:InviterEmail d4p1:nil="false">ValueHere</e534:InviterEmail>
          <e534:InviterName d4p1:nil="false">ValueHere</e534:InviterName>
          <e534:InviterPhone d4p1:nil="false">ValueHere</e534:InviterPhone>
          <e534:IsBillToClient d4p1:nil="false">ValueHere</e534:IsBillToClient>
          <e534:StartDate d4p1:nil="false">ValueHere</e534:StartDate>
          <e534:Status d4p1:nil="false">ValueHere</e534:Status>
          <e534:SuppressNotification>ValueHere</e534:SuppressNotification>
          <e534:LastModifiedDateTime>ValueHere</e534:LastModifiedDateTime>
          <e534:LastModifiedByUserId>ValueHere</e534:LastModifiedByUserId>
          <e534:Timestamp d4p1:nil="false">ValueHere</e534:Timestamp>
          <e534:ForwardCompatibilityMap xmlns:e535="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e535:KeyValuePairOfstringstring>
              <e535:key d4p1:nil="false">ValueHere</e535:key>
              <e535:value d4p1:nil="false">ValueHere</e535:value>
            </e535:KeyValuePairOfstringstring>
          </e534:ForwardCompatibilityMap>
          <e534:CustomerLinkPermission d4p1:nil="false">ValueHere</e534:CustomerLinkPermission>
        </e534:ClientLink>
      </ClientLinks>
    </SearchClientLinksResponse>
  </s:Body>
</s:Envelope>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<SearchClientLinksResponse> SearchClientLinksAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchClientLinksRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchClientLinksAsync(r), request));
}

static SearchClientLinksResponse searchClientLinks(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchClientLinksRequest request = new SearchClientLinksRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);

	return CustomerManagementService.getService().searchClientLinks(request);
}

static function SearchClientLinks(
	$predicates,
	$ordering,
	$pageInfo)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchClientLinksRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchClientLinks($request);
}

response=customermanagement_service.SearchClientLinks(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo)

Requisitos

Servicio: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

Dirección URL de solicitud

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/ClientLinks/Search

Elementos Request

El objeto SearchClientLinksRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
Ordenamiento Determina el orden de los resultados.

Este elemento request es opcional. Si se especifica, solo debe incluir un elemento OrderBy en la lista. No se admiten elementos adicionales y el servicio lo omitirá.

Para esta operación de servicio, se admiten los siguientes valores en el elemento Field de un objeto OrderBy .

Id : el orden viene determinado por el elemento ClientAccountId del clientlink devuelto.

Nombre : el orden viene determinado por el elemento Name del clientlink devuelto.

Número : el orden viene determinado por el elemento ManagingCustomerNumber del clientlink devuelto.		 Matriz OrderBy
PageInfo Determina el índice y el tamaño de los resultados por página. Paginación
Predicados Determina las condiciones que se deben cumplir para devolver vínculos de cliente.

Debe incluir uno o dos predicados.

Para obtener más información sobre cómo se determinan los resultados de cada valor de campo de predicado admitido, vea Comentarios del predicado.		 Matriz de predicados

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto SearchClientLinksResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
ClientLinks Lista de invitaciones de vínculo de cliente. Matriz ClientLink

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  }
}

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

{
  "ClientLinks": [
    {
      "ClientEntityId": "LongValueHere",
      "ClientEntityName": "ValueHere",
      "ClientEntityNumber": "ValueHere",
      "CustomerLinkPermission": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "InviterEmail": "ValueHere",
      "InviterName": "ValueHere",
      "InviterPhone": "ValueHere",
      "IsBillToClient": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedDateTime": "ValueHere",
      "ManagingCustomerId": "LongValueHere",
      "ManagingCustomerName": "ValueHere",
      "ManagingCustomerNumber": "ValueHere",
      "Name": "ValueHere",
      "Note": "ValueHere",
      "StartDate": "ValueHere",
      "Status": "ValueHere",
      "SuppressNotification": "ValueHere",
      "Timestamp": "ValueHere",
      "Type": "ValueHere"
    }
  ]
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<SearchClientLinksResponse> SearchClientLinksAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchClientLinksRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchClientLinksAsync(r), request));
}

static SearchClientLinksResponse searchClientLinks(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchClientLinksRequest request = new SearchClientLinksRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);

	return CustomerManagementService.getService().searchClientLinks(request);
}

static function SearchClientLinks(
	$predicates,
	$ordering,
	$pageInfo)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchClientLinksRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchClientLinks($request);
}

response=customermanagement_service.SearchClientLinks(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo)