Operación de servicio FindAccountsOrCustomersInfo: Administración de clientes
Obtiene una lista de las cuentas y clientes que coinciden con los criterios de filtro especificados.
Elementos Request
El objeto FindAccountsOrCustomersInfoRequest 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 |
|---|---|---|
| Filtro | Criterios que se usarán para filtrar la lista de cuentas y clientes. Puede especificar un nombre de cuenta, un número de cuenta o un nombre de cliente. El valor del filtro puede contener un nombre o número parcial o completo. La operación incluye la cuenta o el cliente en el resultado si el nombre o el número comienzan 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 el número. Por ejemplo, si especifica "t" como valor de filtro, la lista incluirá cuentas y clientes cuyos nombres comiencen por "t" o "T". La operación filtra primero las cuentas que coinciden con los criterios de filtro. Si el número de cuentas que coinciden con los criterios de filtro es menor que el valor TopN especificado, la operación busca clientes cuyo nombre coincida con los criterios de filtro. Establecer este elemento en una cadena vacía es lo mismo que llamar a GetAccountsInfo seguido de llamar a GetCustomersInfo. |
string |
| ReturnAdditionalFields | Lista de propiedades adicionales que desea incluir en cada cuenta devuelta. Los valores de campo adicionales permiten obtener las características más recientes mediante la versión actual de La API de administración de clientes y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada. Este elemento request es opcional. |
AccountAdditionalField |
| 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 FindAccountsOrCustomersInfoResponse 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 |
|---|---|---|
| AccountInfoWithCustomerData | Lista de objetos AccountInfoWithCustomerData de las cuentas y clientes que coinciden con los criterios de filtro especificados. Los objetos contienen información que identifica la cuenta y el cliente. Para obtener los detalles completos de una cuenta de la lista, acceda al elemento AccountId del objeto AccountInfoWithCustomerData y úselo para llamar a la operación GetAccount . Para obtener los detalles completos de un cliente en la lista, acceda al elemento CustomerId del objeto AccountInfoWithCustomerData y úselo para llamar a GetCustomer. |
Matriz AccountInfoWithCustomerData |
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">FindAccountsOrCustomersInfo</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<FindAccountsOrCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Filter i:nil="false">ValueHere</Filter>
<TopN>ValueHere</TopN>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</FindAccountsOrCustomersInfoRequest>
</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>
<FindAccountsOrCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<AccountInfoWithCustomerData xmlns:e485="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e485:AccountInfoWithCustomerData>
<e485:CustomerId d4p1:nil="false">ValueHere</e485:CustomerId>
<e485:CustomerName d4p1:nil="false">ValueHere</e485:CustomerName>
<e485:AccountId>ValueHere</e485:AccountId>
<e485:AccountName d4p1:nil="false">ValueHere</e485:AccountName>
<e485:AccountNumber d4p1:nil="false">ValueHere</e485:AccountNumber>
<e485:AccountLifeCycleStatus>ValueHere</e485:AccountLifeCycleStatus>
<e485:PauseReason d4p1:nil="false">ValueHere</e485:PauseReason>
<e485:AccountMode d4p1:nil="false">ValueHere</e485:AccountMode>
</e485:AccountInfoWithCustomerData>
</AccountInfoWithCustomerData>
</FindAccountsOrCustomersInfoResponse>
</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<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
string filter,
int topN,
AccountAdditionalField? returnAdditionalFields)
{
var request = new FindAccountsOrCustomersInfoRequest
{
Filter = filter,
TopN = topN,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.FindAccountsOrCustomersInfoAsync(r), request));
}
static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
java.lang.String filter,
int topN,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();
request.setFilter(filter);
request.setTopN(topN);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().findAccountsOrCustomersInfo(request);
}
static function FindAccountsOrCustomersInfo(
$filter,
$topN,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new FindAccountsOrCustomersInfoRequest();
$request->Filter = $filter;
$request->TopN = $topN;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->FindAccountsOrCustomersInfo($request);
}
response=customermanagement_service.FindAccountsOrCustomersInfo(
Filter=Filter,
TopN=TopN,
ReturnAdditionalFields=ReturnAdditionalFields)
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/AccountsOrCustomersInfo/Find
Elementos Request
El objeto FindAccountsOrCustomersInfoRequest 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 |
|---|---|---|
| Filtro | Criterios que se usarán para filtrar la lista de cuentas y clientes. Puede especificar un nombre de cuenta, un número de cuenta o un nombre de cliente. El valor del filtro puede contener un nombre o número parcial o completo. La operación incluye la cuenta o el cliente en el resultado si el nombre o el número comienzan 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 el número. Por ejemplo, si especifica "t" como valor de filtro, la lista incluirá cuentas y clientes cuyos nombres comiencen por "t" o "T". La operación filtra primero las cuentas que coinciden con los criterios de filtro. Si el número de cuentas que coinciden con los criterios de filtro es menor que el valor TopN especificado, la operación busca clientes cuyo nombre coincida con los criterios de filtro. Establecer este elemento en una cadena vacía es lo mismo que llamar a GetAccountsInfo seguido de llamar a GetCustomersInfo. |
string |
| ReturnAdditionalFields | Lista de propiedades adicionales que desea incluir en cada cuenta devuelta. Los valores de campo adicionales permiten obtener las características más recientes mediante la versión actual de La API de administración de clientes y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada. Este elemento request es opcional. |
AccountAdditionalField |
| 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 FindAccountsOrCustomersInfoResponse 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 |
|---|---|---|
| AccountInfoWithCustomerData | Lista de objetos AccountInfoWithCustomerData de las cuentas y clientes que coinciden con los criterios de filtro especificados. Los objetos contienen información que identifica la cuenta y el cliente. Para obtener los detalles completos de una cuenta de la lista, acceda al elemento AccountId del objeto AccountInfoWithCustomerData y úselo para llamar a la operación GetAccount . Para obtener los detalles completos de un cliente en la lista, acceda al elemento CustomerId del objeto AccountInfoWithCustomerData y úselo para llamar a GetCustomer. |
Matriz AccountInfoWithCustomerData |
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.
{
"Filter": "ValueHere",
"TopN": IntValueHere,
"ReturnAdditionalFields": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"AccountInfoWithCustomerData": [
{
"AccountId": "LongValueHere",
"AccountLifeCycleStatus": "ValueHere",
"AccountMode": "ValueHere",
"AccountName": "ValueHere",
"AccountNumber": "ValueHere",
"CustomerId": "LongValueHere",
"CustomerName": "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<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
string filter,
int topN,
AccountAdditionalField? returnAdditionalFields)
{
var request = new FindAccountsOrCustomersInfoRequest
{
Filter = filter,
TopN = topN,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.FindAccountsOrCustomersInfoAsync(r), request));
}
static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
java.lang.String filter,
int topN,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();
request.setFilter(filter);
request.setTopN(topN);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().findAccountsOrCustomersInfo(request);
}
static function FindAccountsOrCustomersInfo(
$filter,
$topN,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new FindAccountsOrCustomersInfoRequest();
$request->Filter = $filter;
$request->TopN = $topN;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->FindAccountsOrCustomersInfo($request);
}
response=customermanagement_service.FindAccountsOrCustomersInfo(
Filter=Filter,
TopN=TopN,
ReturnAdditionalFields=ReturnAdditionalFields)