Compartir a través de

Operación de servicio SearchInsertionOrders: facturación del cliente

  • Artículo

Busca pedidos de inserción que coincidan con un criterio especificado.

Elementos Request

El objeto SearchInsertionOrdersRequest 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.

Solo debe especificar 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 orden viene determinado por el elemento Id del objeto InsertionOrder devuelto.

Nombre : el orden viene determinado por el elemento Name del objeto InsertionOrder devuelto.		 Matriz OrderBy
PageInfo Determina el índice y el tamaño de los resultados por página. Paginación
Predicados Determina las condiciones de solicitud. La respuesta de esta operación incluirá cuentas que coincidan con todos los predicados especificados.

Puede especificar hasta 6 predicados y uno de los campos de predicado debe ser AccountId. Puede usar los campos de predicado StartDate y EndDate dos veces cada uno para especificar intervalos de fechas de inicio y finalización, y de lo contrario, solo puede usar cada campo de predicado una vez.

Para obtener una lista de los elementos Field y Operator admitidos de un objeto Predicate para esta operación de servicio, vea Comentarios de predicado.		 Matriz de predicados
ReturnAdditionalFields Lista de propiedades adicionales que desea incluir en cada orden de inserción devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Customer Billing API. Nota: Los elementos correspondientes se incluirán de forma predeterminada en una actualización futura.

Este elemento request es opcional.		 InsertionOrderAdditionalField

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 SearchInsertionOrdersResponse 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
InsertionOrders Lista de pedidos de inserción que cumplen los criterios especificados. Matriz InsertionOrder

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/Billing/v13">
    <Action mustUnderstand="1">SearchInsertionOrders</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchInsertionOrdersRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <Predicates xmlns:e27="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e27:Predicate>
          <e27:Field i:nil="false">ValueHere</e27:Field>
          <e27:Operator>ValueHere</e27:Operator>
          <e27:Value i:nil="false">ValueHere</e27:Value>
        </e27:Predicate>
      </Predicates>
      <Ordering xmlns:e28="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e28:OrderBy>
          <e28:Field>ValueHere</e28:Field>
          <e28:Order>ValueHere</e28:Order>
        </e28:OrderBy>
      </Ordering>
      <PageInfo xmlns:e29="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e29:Index>ValueHere</e29:Index>
        <e29:Size>ValueHere</e29:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchInsertionOrdersRequest>
  </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/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SearchInsertionOrdersResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <InsertionOrders xmlns:e30="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e30:InsertionOrder>
          <e30:AccountId>ValueHere</e30:AccountId>
          <e30:BookingCountryCode d4p1:nil="false">ValueHere</e30:BookingCountryCode>
          <e30:Comment d4p1:nil="false">ValueHere</e30:Comment>
          <e30:EndDate d4p1:nil="false">ValueHere</e30:EndDate>
          <e30:Id d4p1:nil="false">ValueHere</e30:Id>
          <e30:LastModifiedByUserId d4p1:nil="false">ValueHere</e30:LastModifiedByUserId>
          <e30:LastModifiedTime d4p1:nil="false">ValueHere</e30:LastModifiedTime>
          <e30:NotificationThreshold d4p1:nil="false">ValueHere</e30:NotificationThreshold>
          <e30:ReferenceId d4p1:nil="false">ValueHere</e30:ReferenceId>
          <e30:SpendCapAmount d4p1:nil="false">ValueHere</e30:SpendCapAmount>
          <e30:StartDate d4p1:nil="false">ValueHere</e30:StartDate>
          <e30:Name d4p1:nil="false">ValueHere</e30:Name>
          <e30:Status d4p1:nil="false">ValueHere</e30:Status>
          <e30:PurchaseOrder d4p1:nil="false">ValueHere</e30:PurchaseOrder>
          <e30:PendingChanges d4p1:nil="false">
            <e30:Comment d4p1:nil="false">ValueHere</e30:Comment>
            <e30:EndDate d4p1:nil="false">ValueHere</e30:EndDate>
            <e30:RequestedByUserId d4p1:nil="false">ValueHere</e30:RequestedByUserId>
            <e30:ModifiedDateTime d4p1:nil="false">ValueHere</e30:ModifiedDateTime>
            <e30:NotificationThreshold d4p1:nil="false">ValueHere</e30:NotificationThreshold>
            <e30:ReferenceId d4p1:nil="false">ValueHere</e30:ReferenceId>
            <e30:SpendCapAmount d4p1:nil="false">ValueHere</e30:SpendCapAmount>
            <e30:StartDate d4p1:nil="false">ValueHere</e30:StartDate>
            <e30:Name d4p1:nil="false">ValueHere</e30:Name>
            <e30:PurchaseOrder d4p1:nil="false">ValueHere</e30:PurchaseOrder>
            <e30:ChangeStatus d4p1:nil="false">ValueHere</e30:ChangeStatus>
          </e30:PendingChanges>
          <e30:AccountNumber d4p1:nil="false">ValueHere</e30:AccountNumber>
          <e30:BudgetRemaining d4p1:nil="false">ValueHere</e30:BudgetRemaining>
          <e30:BudgetSpent d4p1:nil="false">ValueHere</e30:BudgetSpent>
          <e30:BudgetRemainingPercent d4p1:nil="false">ValueHere</e30:BudgetRemainingPercent>
          <e30:BudgetSpentPercent d4p1:nil="false">ValueHere</e30:BudgetSpentPercent>
          <e30:SeriesName d4p1:nil="false">ValueHere</e30:SeriesName>
          <e30:IsInSeries d4p1:nil="false">ValueHere</e30:IsInSeries>
          <e30:SeriesFrequencyType d4p1:nil="false">ValueHere</e30:SeriesFrequencyType>
          <e30:IsUnlimited d4p1:nil="false">ValueHere</e30:IsUnlimited>
          <e30:IsEndless d4p1:nil="false">ValueHere</e30:IsEndless>
        </e30:InsertionOrder>
      </InsertionOrders>
    </SearchInsertionOrdersResponse>
  </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<SearchInsertionOrdersResponse> SearchInsertionOrdersAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	InsertionOrderAdditionalField? returnAdditionalFields)
{
	var request = new SearchInsertionOrdersRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.SearchInsertionOrdersAsync(r), request));
}

static SearchInsertionOrdersResponse searchInsertionOrders(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<InsertionOrderAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchInsertionOrdersRequest request = new SearchInsertionOrdersRequest();

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

	return CustomerBillingService.getService().searchInsertionOrders(request);
}

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

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

	$request = new SearchInsertionOrdersRequest();

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

	return $GLOBALS['CustomerBillingProxy']->GetService()->SearchInsertionOrders($request);
}

response=customerbilling_service.SearchInsertionOrders(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requisitos

Servicio: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Billing/v13

Dirección URL de solicitud

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/InsertionOrders/Search

Elementos Request

El objeto SearchInsertionOrdersRequest 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.

Solo debe especificar 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 orden viene determinado por el elemento Id del objeto InsertionOrder devuelto.

Nombre : el orden viene determinado por el elemento Name del objeto InsertionOrder devuelto.		 Matriz OrderBy
PageInfo Determina el índice y el tamaño de los resultados por página. Paginación
Predicados Determina las condiciones de solicitud. La respuesta de esta operación incluirá cuentas que coincidan con todos los predicados especificados.

Puede especificar hasta 6 predicados y uno de los campos de predicado debe ser AccountId. Puede usar los campos de predicado StartDate y EndDate dos veces cada uno para especificar intervalos de fechas de inicio y finalización, y de lo contrario, solo puede usar cada campo de predicado una vez.

Para obtener una lista de los elementos Field y Operator admitidos de un objeto Predicate para esta operación de servicio, vea Comentarios de predicado.		 Matriz de predicados
ReturnAdditionalFields Lista de propiedades adicionales que desea incluir en cada orden de inserción devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Customer Billing API. Nota: Los elementos correspondientes se incluirán de forma predeterminada en una actualización futura.

Este elemento request es opcional.		 InsertionOrderAdditionalField

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 SearchInsertionOrdersResponse 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
InsertionOrders Lista de pedidos de inserción que cumplen los criterios especificados. Matriz InsertionOrder

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.

{
  "InsertionOrders": [
    {
      "AccountId": "LongValueHere",
      "AccountNumber": "ValueHere",
      "BookingCountryCode": "ValueHere",
      "BudgetRemaining": DoubleValueHere,
      "BudgetRemainingPercent": DoubleValueHere,
      "BudgetSpent": DoubleValueHere,
      "BudgetSpentPercent": DoubleValueHere,
      "Comment": "ValueHere",
      "EndDate": "ValueHere",
      "Id": "LongValueHere",
      "IsEndless": "ValueHere",
      "IsInSeries": "ValueHere",
      "IsUnlimited": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "Name": "ValueHere",
      "NotificationThreshold": DoubleValueHere,
      "PendingChanges": {
        "ChangeStatus": "ValueHere",
        "Comment": "ValueHere",
        "EndDate": "ValueHere",
        "ModifiedDateTime": "ValueHere",
        "Name": "ValueHere",
        "NotificationThreshold": DoubleValueHere,
        "PurchaseOrder": "ValueHere",
        "ReferenceId": "LongValueHere",
        "RequestedByUserId": IntValueHere,
        "SpendCapAmount": DoubleValueHere,
        "StartDate": "ValueHere"
      },
      "PurchaseOrder": "ValueHere",
      "ReferenceId": "LongValueHere",
      "SeriesFrequencyType": "ValueHere",
      "SeriesName": "ValueHere",
      "SpendCapAmount": DoubleValueHere,
      "StartDate": "ValueHere",
      "Status": "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<SearchInsertionOrdersResponse> SearchInsertionOrdersAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	InsertionOrderAdditionalField? returnAdditionalFields)
{
	var request = new SearchInsertionOrdersRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.SearchInsertionOrdersAsync(r), request));
}

static SearchInsertionOrdersResponse searchInsertionOrders(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<InsertionOrderAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchInsertionOrdersRequest request = new SearchInsertionOrdersRequest();

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

	return CustomerBillingService.getService().searchInsertionOrders(request);
}

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

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

	$request = new SearchInsertionOrdersRequest();

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

	return $GLOBALS['CustomerBillingProxy']->GetService()->SearchInsertionOrders($request);
}

response=customerbilling_service.SearchInsertionOrders(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)