Compartir a través de

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

  • Artículo

Obtiene una lista de cuentas propiedad del cliente especificado que coinciden con los criterios de filtro especificados.

Elementos Request

El objeto FindAccountsRequest 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
AccountFilter Criterios que se usarán para filtrar la lista de cuentas. Puede especificar un nombre de cuenta o un número de cuenta. Si el valor del filtro tiene el formato Xnnnnnn, donde nnnnn es una serie de dígitos, la operación se filtra por número de cuenta.

El valor del filtro puede contener un nombre de cuenta parcial o completo o el número de las cuentas que desea obtener. La operación incluye la cuenta en el resultado si el nombre o número de la cuenta comienza con el valor de filtro especificado.

La operación realiza una comparación sin distinción entre mayúsculas y minúsculas cuando compara el valor del filtro con el nombre o número de cuenta. Por ejemplo, si especifica "t" como valor de filtro, la lista incluirá cuentas cuyos nombres comiencen por "t" o "T".

Establecer este elemento en una cadena vacía es lo mismo que llamar a GetAccountsInfo.		 string
CustomerId Identificador del cliente cuyas cuentas desea obtener.

Si es null, la operación busca una coincidencia entre todas las cuentas de los clientes que el usuario administra y posee.		 largo
TopN Entero positivo distinto de cero que especifica el número de cuentas que se devolverán en el resultado. Debe especificar un valor de 1 a 5000. int

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 FindAccountsResponse 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
AccountsInfo Lista de objetos AccountInfo de las cuentas que coinciden con los criterios de filtro especificados.

Para obtener los detalles completos de una cuenta de la lista, acceda al elemento Id del objeto AccountInfo y úselo para llamar a GetAccount.		 Matriz AccountInfo

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">FindAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <AccountFilter i:nil="false">ValueHere</AccountFilter>
      <TopN>ValueHere</TopN>
    </FindAccountsRequest>
  </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>
    <FindAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e483="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e483:AccountInfo>
          <e483:Id>ValueHere</e483:Id>
          <e483:Name d4p1:nil="false">ValueHere</e483:Name>
          <e483:Number d4p1:nil="false">ValueHere</e483:Number>
          <e483:AccountLifeCycleStatus>ValueHere</e483:AccountLifeCycleStatus>
          <e483:PauseReason d4p1:nil="false">ValueHere</e483:PauseReason>
        </e483:AccountInfo>
      </AccountsInfo>
    </FindAccountsResponse>
  </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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	TopN=TopN)

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/Accounts/Find

Elementos Request

El objeto FindAccountsRequest 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
AccountFilter Criterios que se usarán para filtrar la lista de cuentas. Puede especificar un nombre de cuenta o un número de cuenta. Si el valor del filtro tiene el formato Xnnnnnn, donde nnnnn es una serie de dígitos, la operación se filtra por número de cuenta.

El valor del filtro puede contener un nombre de cuenta parcial o completo o el número de las cuentas que desea obtener. La operación incluye la cuenta en el resultado si el nombre o número de la cuenta comienza con el valor de filtro especificado.

La operación realiza una comparación sin distinción entre mayúsculas y minúsculas cuando compara el valor del filtro con el nombre o número de cuenta. Por ejemplo, si especifica "t" como valor de filtro, la lista incluirá cuentas cuyos nombres comiencen por "t" o "T".

Establecer este elemento en una cadena vacía es lo mismo que llamar a GetAccountsInfo.		 string
CustomerId Identificador del cliente cuyas cuentas desea obtener.

Si es null, la operación busca una coincidencia entre todas las cuentas de los clientes que el usuario administra y posee.		 largo
TopN Entero positivo distinto de cero que especifica el número de cuentas que se devolverán en el resultado. Debe especificar un valor de 1 a 5000. int

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 FindAccountsResponse 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
AccountsInfo Lista de objetos AccountInfo de las cuentas que coinciden con los criterios de filtro especificados.

Para obtener los detalles completos de una cuenta de la lista, acceda al elemento Id del objeto AccountInfo y úselo para llamar a GetAccount.		 Matriz AccountInfo

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.

{
  "CustomerId": "LongValueHere",
  "AccountFilter": "ValueHere",
  "TopN": IntValueHere
}

JSON de respuesta

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

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "PauseReason": "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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	TopN=TopN)