Compartir vía

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

  • Artículo

Busca cuentas que coincidan con los criterios de solicitud.

Por ejemplo, puede buscar cuentas a las que pueda acceder el usuario autenticado actual.

Sugerencia

Consulte la Guía de permisos de usuario y hierchy de la cuenta para obtener información general con ejemplos.

Elementos Request

El objeto SearchAccountsRequest 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 por la propiedad especificada de una cuenta.

Este elemento request es opcional. Puede especificar hasta un elemento OrderBy en la matriz. No se admiten elementos adicionales y el servicio lo omitirá.

Si establece el elemento Field del objeto OrderBy en "Id", "Name" o "Number", los identificadores, nombres o números de la cuenta ordenarán las cuentas devueltas en consecuencia.

Este elemento request es opcional.		 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 cuentas.

Debe incluir exactamente un predicado. Si el predicado Field está establecido en "AccountLifeCycleStatus", debe especificar un predicado adicional con el campo establecido en otro valor, como UserId.

Para obtener más información sobre cada valor de campo de predicado admitido, vea Comentarios del predicado.		 Matriz de predicados
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

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 SearchAccountsResponse 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
Cuentas Lista de cuentas que cumplen los criterios de solicitud. Matriz AdvertiserAccount

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">SearchAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e53="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e53:Predicate>
          <e53:Field i:nil="false">ValueHere</e53:Field>
          <e53:Operator>ValueHere</e53:Operator>
          <e53:Value i:nil="false">ValueHere</e53:Value>
        </e53:Predicate>
      </Predicates>
      <Ordering xmlns:e54="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e54:OrderBy>
          <e54:Field>ValueHere</e54:Field>
          <e54:Order>ValueHere</e54:Order>
        </e54:OrderBy>
      </Ordering>
      <PageInfo xmlns:e55="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e55:Index>ValueHere</e55:Index>
        <e55:Size>ValueHere</e55:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchAccountsRequest>
  </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>
    <SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Accounts xmlns:e56="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e56:AdvertiserAccount>
          <e56:BillToCustomerId d4p1:nil="false">ValueHere</e56:BillToCustomerId>
          <e56:CurrencyCode d4p1:nil="false">ValueHere</e56:CurrencyCode>
          <e56:AccountFinancialStatus d4p1:nil="false">ValueHere</e56:AccountFinancialStatus>
          <e56:Id d4p1:nil="false">ValueHere</e56:Id>
          <e56:Language d4p1:nil="false">ValueHere</e56:Language>
          <e56:LastModifiedByUserId d4p1:nil="false">ValueHere</e56:LastModifiedByUserId>
          <e56:LastModifiedTime d4p1:nil="false">ValueHere</e56:LastModifiedTime>
          <e56:Name d4p1:nil="false">ValueHere</e56:Name>
          <e56:Number d4p1:nil="false">ValueHere</e56:Number>
          <e56:ParentCustomerId>ValueHere</e56:ParentCustomerId>
          <e56:PaymentMethodId d4p1:nil="false">ValueHere</e56:PaymentMethodId>
          <e56:PaymentMethodType d4p1:nil="false">ValueHere</e56:PaymentMethodType>
          <e56:PrimaryUserId d4p1:nil="false">ValueHere</e56:PrimaryUserId>
          <e56:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e56:AccountLifeCycleStatus>
          <e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
          <e56:TimeZone d4p1:nil="false">ValueHere</e56:TimeZone>
          <e56:PauseReason d4p1:nil="false">ValueHere</e56:PauseReason>
          <e56:ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e57:KeyValuePairOfstringstring>
              <e57:key d4p1:nil="false">ValueHere</e57:key>
              <e57:value d4p1:nil="false">ValueHere</e57:value>
            </e57:KeyValuePairOfstringstring>
          </e56:ForwardCompatibilityMap>
          <e56:LinkedAgencies d4p1:nil="false">
            <e56:CustomerInfo>
              <e56:Id d4p1:nil="false">ValueHere</e56:Id>
              <e56:Name d4p1:nil="false">ValueHere</e56:Name>
            </e56:CustomerInfo>
          </e56:LinkedAgencies>
          <e56:SalesHouseCustomerId d4p1:nil="false">ValueHere</e56:SalesHouseCustomerId>
          <e56:TaxInformation xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e58:KeyValuePairOfstringstring>
              <e58:key d4p1:nil="false">ValueHere</e58:key>
              <e58:value d4p1:nil="false">ValueHere</e58:value>
            </e58:KeyValuePairOfstringstring>
          </e56:TaxInformation>
          <e56:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e56:BackUpPaymentInstrumentId>
          <e56:BillingThresholdAmount d4p1:nil="false">ValueHere</e56:BillingThresholdAmount>
          <e56:BusinessAddress d4p1:nil="false">
            <e56:City d4p1:nil="false">ValueHere</e56:City>
            <e56:CountryCode d4p1:nil="false">ValueHere</e56:CountryCode>
            <e56:Id d4p1:nil="false">ValueHere</e56:Id>
            <e56:Line1 d4p1:nil="false">ValueHere</e56:Line1>
            <e56:Line2 d4p1:nil="false">ValueHere</e56:Line2>
            <e56:Line3 d4p1:nil="false">ValueHere</e56:Line3>
            <e56:Line4 d4p1:nil="false">ValueHere</e56:Line4>
            <e56:PostalCode d4p1:nil="false">ValueHere</e56:PostalCode>
            <e56:StateOrProvince d4p1:nil="false">ValueHere</e56:StateOrProvince>
            <e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
            <e56:BusinessName d4p1:nil="false">ValueHere</e56:BusinessName>
          </e56:BusinessAddress>
          <e56:AutoTagType d4p1:nil="false">ValueHere</e56:AutoTagType>
          <e56:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e56:SoldToPaymentInstrumentId>
          <e56:TaxCertificate d4p1:nil="false">
            <e56:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e56:TaxCertificateBlobContainerName>
            <e56:TaxCertificates xmlns:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
              <e59:KeyValuePairOfstringbase64Binary>
                <e59:key d4p1:nil="false">ValueHere</e59:key>
                <e59:value d4p1:nil="false">ValueHere</e59:value>
              </e59:KeyValuePairOfstringbase64Binary>
            </e56:TaxCertificates>
            <e56:Status d4p1:nil="false">ValueHere</e56:Status>
          </e56:TaxCertificate>
          <e56:AccountMode d4p1:nil="false">ValueHere</e56:AccountMode>
        </e56:AdvertiserAccount>
      </Accounts>
    </SearchAccountsResponse>
  </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<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

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

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

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

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	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/Accounts/Search

Elementos Request

El objeto SearchAccountsRequest 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 por la propiedad especificada de una cuenta.

Este elemento request es opcional. Puede especificar hasta un elemento OrderBy en la matriz. No se admiten elementos adicionales y el servicio lo omitirá.

Si establece el elemento Field del objeto OrderBy en "Id", "Name" o "Number", los identificadores, nombres o números de la cuenta ordenarán las cuentas devueltas en consecuencia.

Este elemento request es opcional.		 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 cuentas.

Debe incluir exactamente un predicado. Si el predicado Field está establecido en "AccountLifeCycleStatus", debe especificar un predicado adicional con el campo establecido en otro valor, como UserId.

Para obtener más información sobre cada valor de campo de predicado admitido, vea Comentarios del predicado.		 Matriz de predicados
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

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 SearchAccountsResponse 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
Cuentas Lista de cuentas que cumplen los criterios de solicitud. Matriz AdvertiserAccount

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
  },
  "ReturnAdditionalFields": "ValueHere"
}

JSON de respuesta

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

{
  "Accounts": [
    {
      "AccountFinancialStatus": "ValueHere",
      "AccountLifeCycleStatus": "ValueHere",
      "AccountMode": "ValueHere",
      "AutoTagType": "ValueHere",
      "BackUpPaymentInstrumentId": "LongValueHere",
      "BillingThresholdAmount": DecimalValueHere,
      "BillToCustomerId": "LongValueHere",
      "BusinessAddress": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "CurrencyCode": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Language": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "LinkedAgencies": [
        {
          "Id": "LongValueHere",
          "Name": "ValueHere"
        }
      ],
      "Name": "ValueHere",
      "Number": "ValueHere",
      "ParentCustomerId": "LongValueHere",
      "PauseReason": "ValueHere",
      "PaymentMethodId": "LongValueHere",
      "PaymentMethodType": "ValueHere",
      "PrimaryUserId": "LongValueHere",
      "SalesHouseCustomerId": "LongValueHere",
      "SoldToPaymentInstrumentId": "LongValueHere",
      "TaxCertificate": {
        "Status": "ValueHere",
        "TaxCertificateBlobContainerName": "ValueHere",
        "TaxCertificates": [
          {
            "key": "ValueHere",
            "value": "ValueHere"
          }
        ]
      },
      "TaxInformation": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "TimeStamp": "ValueHere",
      "TimeZone": "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<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

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

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

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

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)