Compartir a través de

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

  • Artículo

Busca clientes que coincidan con los criterios de solicitud.

Elementos Request

El objeto SearchCustomersRequest 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
DateRange Determina el intervalo de fechas de creación de clientes mínimo y máximo.

Este elemento request es opcional.		 DateRange
Ordenamiento Determina el orden de los resultados por la propiedad especificada de un cliente.

Este elemento request es opcional. Puede especificar hasta un elemento OrderBy en la matriz. 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 pedido viene determinado por el elemento Id del cliente devuelto.

Nombre : el pedido viene determinado por el elemento Name del cliente devuelto.

Número : el pedido viene determinado por el elemento Number del cliente 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 clientes.

Debe incluir entre uno y 10 predicados. Para filtrar por el intervalo de fechas creado, puede incluir dos predicados con el valor Field establecido en CreatedDate y, de lo contrario, solo puede usar cada campo de predicado una vez.

Para obtener más información sobre 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 SearchCustomersResponse 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
Clientela Lista de clientes que cumplen los criterios de solicitud. Matriz de clientes

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">SearchCustomers</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchCustomersRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e541="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e541:Predicate>
          <e541:Field i:nil="false">ValueHere</e541:Field>
          <e541:Operator>ValueHere</e541:Operator>
          <e541:Value i:nil="false">ValueHere</e541:Value>
        </e541:Predicate>
      </Predicates>
      <DateRange xmlns:e542="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e542:MinDate i:nil="false">ValueHere</e542:MinDate>
        <e542:MaxDate i:nil="false">ValueHere</e542:MaxDate>
      </DateRange>
      <Ordering xmlns:e543="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e543:OrderBy>
          <e543:Field>ValueHere</e543:Field>
          <e543:Order>ValueHere</e543:Order>
        </e543:OrderBy>
      </Ordering>
      <PageInfo xmlns:e544="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e544:Index>ValueHere</e544:Index>
        <e544:Size>ValueHere</e544:Size>
      </PageInfo>
    </SearchCustomersRequest>
  </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>
    <SearchCustomersResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Customers xmlns:e545="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e545:Customer>
          <e545:CustomerFinancialStatus d4p1:nil="false">ValueHere</e545:CustomerFinancialStatus>
          <e545:Id d4p1:nil="false">ValueHere</e545:Id>
          <e545:Industry d4p1:nil="false">ValueHere</e545:Industry>
          <e545:LastModifiedByUserId d4p1:nil="false">ValueHere</e545:LastModifiedByUserId>
          <e545:LastModifiedTime d4p1:nil="false">ValueHere</e545:LastModifiedTime>
          <e545:MarketCountry d4p1:nil="false">ValueHere</e545:MarketCountry>
          <e545:ForwardCompatibilityMap xmlns:e546="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e546:KeyValuePairOfstringstring>
              <e546:key d4p1:nil="false">ValueHere</e546:key>
              <e546:value d4p1:nil="false">ValueHere</e546:value>
            </e546:KeyValuePairOfstringstring>
          </e545:ForwardCompatibilityMap>
          <e545:MarketLanguage d4p1:nil="false">ValueHere</e545:MarketLanguage>
          <e545:Name d4p1:nil="false">ValueHere</e545:Name>
          <e545:ServiceLevel d4p1:nil="false">ValueHere</e545:ServiceLevel>
          <e545:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e545:CustomerLifeCycleStatus>
          <e545:TimeStamp d4p1:nil="false">ValueHere</e545:TimeStamp>
          <e545:Number d4p1:nil="false">ValueHere</e545:Number>
          <e545:CustomerAddress d4p1:nil="false">
            <e545:City d4p1:nil="false">ValueHere</e545:City>
            <e545:CountryCode d4p1:nil="false">ValueHere</e545:CountryCode>
            <e545:Id d4p1:nil="false">ValueHere</e545:Id>
            <e545:Line1 d4p1:nil="false">ValueHere</e545:Line1>
            <e545:Line2 d4p1:nil="false">ValueHere</e545:Line2>
            <e545:Line3 d4p1:nil="false">ValueHere</e545:Line3>
            <e545:Line4 d4p1:nil="false">ValueHere</e545:Line4>
            <e545:PostalCode d4p1:nil="false">ValueHere</e545:PostalCode>
            <e545:StateOrProvince d4p1:nil="false">ValueHere</e545:StateOrProvince>
            <e545:TimeStamp d4p1:nil="false">ValueHere</e545:TimeStamp>
            <e545:BusinessName d4p1:nil="false">ValueHere</e545:BusinessName>
          </e545:CustomerAddress>
        </e545:Customer>
      </Customers>
    </SearchCustomersResponse>
  </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<SearchCustomersResponse> SearchCustomersAsync(
	IList<Predicate> predicates,
	DateRange dateRange,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchCustomersRequest
	{
		Predicates = predicates,
		DateRange = dateRange,
		Ordering = ordering,
		PageInfo = pageInfo
	};

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

static SearchCustomersResponse searchCustomers(
	ArrayOfPredicate predicates,
	DateRange dateRange,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchCustomersRequest request = new SearchCustomersRequest();

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

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

static function SearchCustomers(
	$predicates,
	$dateRange,
	$ordering,
	$pageInfo)
{

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

	$request = new SearchCustomersRequest();

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

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

response=customermanagement_service.SearchCustomers(
	Predicates=Predicates,
	DateRange=DateRange,
	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/Customers/Search

Elementos Request

El objeto SearchCustomersRequest 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
DateRange Determina el intervalo de fechas de creación de clientes mínimo y máximo.

Este elemento request es opcional.		 DateRange
Ordenamiento Determina el orden de los resultados por la propiedad especificada de un cliente.

Este elemento request es opcional. Puede especificar hasta un elemento OrderBy en la matriz. 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 pedido viene determinado por el elemento Id del cliente devuelto.

Nombre : el pedido viene determinado por el elemento Name del cliente devuelto.

Número : el pedido viene determinado por el elemento Number del cliente 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 clientes.

Debe incluir entre uno y 10 predicados. Para filtrar por el intervalo de fechas creado, puede incluir dos predicados con el valor Field establecido en CreatedDate y, de lo contrario, solo puede usar cada campo de predicado una vez.

Para obtener más información sobre 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 SearchCustomersResponse 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
Clientela Lista de clientes que cumplen los criterios de solicitud. Matriz de clientes

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"
    }
  ],
  "DateRange": {
    "MaxDate": "ValueHere",
    "MinDate": "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.

{
  "Customers": [
    {
      "CustomerAddress": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "CustomerFinancialStatus": "ValueHere",
      "CustomerLifeCycleStatus": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Industry": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "MarketCountry": "ValueHere",
      "MarketLanguage": "ValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "ServiceLevel": "ValueHere",
      "TimeStamp": "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<SearchCustomersResponse> SearchCustomersAsync(
	IList<Predicate> predicates,
	DateRange dateRange,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchCustomersRequest
	{
		Predicates = predicates,
		DateRange = dateRange,
		Ordering = ordering,
		PageInfo = pageInfo
	};

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

static SearchCustomersResponse searchCustomers(
	ArrayOfPredicate predicates,
	DateRange dateRange,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchCustomersRequest request = new SearchCustomersRequest();

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

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

static function SearchCustomers(
	$predicates,
	$dateRange,
	$ordering,
	$pageInfo)
{

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

	$request = new SearchCustomersRequest();

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

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

response=customermanagement_service.SearchCustomers(
	Predicates=Predicates,
	DateRange=DateRange,
	Ordering=Ordering,
	PageInfo=PageInfo)