Compartir a través de

Objeto de datos InsertionOrder: facturación del cliente

  • Artículo

Un pedido de inserción es un contrato que establece el importe máximo que gastará en su cuenta durante un período de tiempo especificado. Si tienes configurada la facturación mensual de tu cuenta, debes tener un pedido de inserción activo para que tus anuncios sean aptos para la entrega. Todavía controlas el gasto con tu presupuesto de campaña y solo se te cobrará por lo que acumulas. Por ejemplo, si tenía un pedido de inserción de un mes por 5.000 USD y acumulaba solo 4.500 USD en cargos durante el período de facturación, solo se deducirán 4.500 USD del presupuesto de su pedido de inserción.

Advertencia

El presupuesto del pedido de inserción solo se aplica al gasto en anuncios, que es una distinción importante si su empresa se encuentra en un país o región en el que servicios en línea están sujetos a impuestos. Si tiene un límite presupuestado estricto, es posible que tenga que tener en cuenta los impuestos en el presupuesto de la orden de inserción. Para obtener más información sobre los requisitos fiscales en la ubicación de su empresa, consulte el artículo de ayuda de información fiscal o de IVA .

La mayoría de los elementos de este objeto solo se pueden establecer antes de que se apruebe el orden de inserción, es decir, si status está establecido en PendingUserReview. En ese caso, puede realizar nuevos cambios o aprobar o rechazar el orden de inserción a través de elementos de este objeto. Una vez que el estado del pedido de inserción es Activo, Agotado, Expirado o NotStarted, puede realizar nuevos cambios o aprobar o rechazar los cambios pendientes actuales a través del elemento PendingChanges . Si el estado del pedido de inserción es Cancelado o Rechazado, no se puede actualizar el orden de inserción.

Nota:

La operación SearchInsertionOrders devolverá hasta 24 pedidos de inserción por serie periódica.

Puede recuperar, pero con muy pocas excepciones, no puede agregar ni actualizar una serie de pedidos de inserción a través de la API de Bing Ads. Utilice el elemento IsInSeries para determinar si el orden de inserción está en una serie periódica.

  • Si intenta actualizar StartDate o EndDate de un orden de inserción que forma parte de una serie periódica, la API devolverá un error.
  • Si actualiza el estado de un orden de inserción que forma parte de una serie periódica, la actualización de estado se aplicará a todos los pedidos de inserción de la serie.

Para administrar pedidos de inserción periódicos en la aplicación web de Microsoft Advertising, consulte el artículo de ayuda Cómo crear y editar un pedido de inserción.

Sintaxis

<xs:complexType name="InsertionOrder" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountId" type="xs:long" />
    <xs:element minOccurs="0" name="BookingCountryCode" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Comment" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="NotificationThreshold" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="ReferenceId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="SpendCapAmount" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Status" nillable="true" type="tns:InsertionOrderStatus" />
    <xs:element minOccurs="0" name="PurchaseOrder" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="PendingChanges" nillable="true" type="tns:InsertionOrderPendingChanges" />
    <xs:element minOccurs="0" name="AccountNumber" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="BudgetRemaining" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="BudgetSpent" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="BudgetRemainingPercent" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="BudgetSpentPercent" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="SeriesName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="IsInSeries" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="SeriesFrequencyType" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="IsUnlimited" nillable="true" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element minOccurs="0" name="IsEndless" nillable="true" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

Elementos

El objeto InsertionOrder tiene los siguientes elementos: AccountId, AccountNumber, BookingCountryCode, BudgetRemaining, BudgetRemainingPercent, BudgetSpent, BudgetSpentPercent, Comment, EndDate, Id, IsEndless, IsInSeries, IsUnlimited, LastModifiedByUserId, LastModifiedTime, Name, NotificationThreshold, PendingChanges, PurchaseOrder, ReferenceId, SeriesFrequencyType, SeriesName, SpendCapAmount, StartDate, Status.

Elemento Descripción Tipo de datos
AccountId Identificador de la cuenta a la que se aplica el orden de inserción.

No se puede actualizar el identificador de cuenta después de crear el orden de inserción.

Agregar: Obligatorio
Actualizar: Solo lectura		 largo
AccountNumber Número de cuenta generado por el sistema que se usa para identificar la cuenta en la aplicación web de Microsoft Advertising. El número de cuenta tiene el formato xxxxxxxx, donde xxxxxxxx es una serie de ocho caracteres alfanuméricos.

Agregar: Solo lectura
Actualizar: Solo lectura		 string
BookingCountryCode Reservado para uso interno.

Agregar: Necesario para algunas cuentas; Opcional para algunas cuentas.
Actualizar: Solo lectura		 string
BudgetRemaining Equilibrio de ejecución del orden de inserción.

El valor del saldo en ejecución es inicialmente el mismo que SpendCapAmount y, a continuación, disminuye cada vez que se envía un anuncio en la cuenta.

Este elemento está vacío si el orden de inserción tiene presupuesto ilimitado.

Agregar: Solo lectura
Actualizar: Solo lectura		 doble
BudgetRemainingPercent Porcentaje del presupuesto restante para el orden de inserción.

Este valor se calcula como BudgetRemaining / SpendCapAmount.

Este elemento está vacío si el orden de inserción tiene presupuesto ilimitado.

Agregar: Solo lectura
Actualizar: Solo lectura		 doble
BudgetSpent El saldo restante del orden de inserción.

El saldo restante es inicialmente 0 (cero) y, a continuación, aumenta hacia spendCapAmount cada vez que se sirve un anuncio en la cuenta.

Este elemento está vacío si el orden de inserción tiene presupuesto ilimitado.

Agregar: Solo lectura
Actualizar: Solo lectura		 doble
BudgetSpentPercent Porcentaje del presupuesto invertido para el orden de inserción.

Este valor se calcula como BudgetSpent / SpendCapAmount.

Este elemento está vacío si el orden de inserción tiene presupuesto ilimitado.

Agregar: Solo lectura
Actualizar: Solo lectura		 doble
Comentario Descripción del orden de inserción. La descripción está limitada a 100 caracteres.

Agregar: Opcional
Actualizar: Opcional		 string
EndDate Fecha de expiración del pedido de inserción. La fecha de finalización debe ser posterior a la fecha de inicio.

La fecha se almacena en hora universal coordinada (UTC). Solo se usan el mes, el día y el año de la cadena especificada. Si especifica la hora, los minutos y los segundos de una fecha, se omitirán.

Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos.

Nota: Si el pedido de inserción no tiene ninguna fecha de finalización, EndDate está vacío. No se admite la adición o actualización de pedidos de inserción ilimitados. EndDate funciona en modo de solo lectura.

Agregar: Obligatorio
Actualizar: Opcional. Si intenta actualizar StartDate o EndDate de un orden de inserción que forma parte de una serie periódica , la API devolverá un error.		 dateTime
Identificación Identificador generado por el sistema que identifica el orden de inserción.

Agregar: Solo lectura
Actualizar: Solo lectura y Obligatorio		 largo
IsEndless Determina si el pedido de inserción no tiene fecha de finalización.

Si el valor es True, el orden de inserción no tendrá fecha de finalización y se omitirá endDate de este orden de inserción.

Agregar: Opcional
Actualizar: Opcional		 boolean
IsInSeries Determina si el orden de inserción está en una serie periódica.

Si el valor es True, el orden de inserción forma parte de una serie periódica. Si intenta actualizar StartDate o EndDate de un orden de inserción que forma parte de una serie periódica, la API devolverá un error. Si actualiza el estado de un orden de inserción que forma parte de una serie periódica, la actualización de estado se aplicará a todos los pedidos de inserción de la serie.

Agregar: Solo lectura
Actualizar: Solo lectura		 boolean
IsUnlimited Determina si el pedido de inserción tiene presupuesto ilimitado.

Si el valor es True, el orden de inserción tendrá presupuesto ilimitado y se omitirá spendCapAmount de este orden de inserción.

Agregar: Opcional
Actualizar: Opcional		 boolean
LastModifiedByUserId Identificador del último usuario en actualizar el orden de inserción.

Agregar: Solo lectura
Actualizar: Solo lectura		 largo
LastModifiedTime Fecha y hora en que se actualizó por última vez el pedido de inserción.

La fecha se almacena en hora universal coordinada (UTC).

Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos.

Agregar: Solo lectura
Actualizar: Solo lectura		 dateTime
Nombre Nombre descriptivo que se puede usar para hacer referencia a este orden de inserción.

El nombre puede contener un máximo de 100 caracteres.

No es necesario que el nombre sea único en comparación con otros pedidos de inserción para el cliente.

Agregar: Opcional
Actualizar: Opcional		 string
NotificationThreshold Porcentaje del presupuesto que se ha gastado. Especifique el porcentaje como un valor de 0 a 100. La notificación se envía cuando se alcanza el umbral. Por ejemplo, si establece el umbral en 70, el servicio de facturación envía una notificación cuando se ha gastado el 70 por ciento del presupuesto.

Si no desea recibir una notificación, establezca en NULL.

Reservado para uso interno.

Agregar: Opcional
Actualizar: Opcional		 doble
PendingChanges Se puede usar para administrar los cambios de un pedido de inserción aprobado con el estado establecido en Active, Exhaust, Expired o NotStarted.

Agregar: Solo lectura
Actualizar: Opcional		 InsertionOrderPendingChanges
PurchaseOrder Valor de pedido de compra que se puede usar para hacer referencia a este pedido de inserción en facturas mensuales. Este valor se imprimirá como pedido de compra en las facturas mensuales.

El pedido de compra puede contener un máximo de 50 caracteres.

Agregar: Opcional
Actualizar: Opcional		 string
ReferenceId Reservado solo para uso interno.

Agregar: Opcional
Actualizar: Opcional		 largo
SeriesFrequencyType Determina cómo se repite un pedido en la serie.

Los valores posibles son Monthly, BiMonthly, Quarterly y Yearly.

Agregar: Solo lectura
Actualizar: Solo lectura		 string
SeriesName Nombre de la serie de orden de inserción periódica.

El nombre puede contener un máximo de 100 caracteres.

Incluso si el orden de inserción se quita más adelante de la serie periódica, este elemento seguirá reflejando el nombre de la serie en la que se creó.

Agregar: Solo lectura
Actualizar: Solo lectura		 string
SpendCapAmount Presupuesto de esta orden de inserción. El presupuesto es un límite difícil. Cuando la cuenta alcanza este límite y no hay otro pedido de inserción disponible, el valor de estado del ciclo de vida de la cuenta se establece en Pausar.

Este elemento está vacío si el orden de inserción tiene presupuesto ilimitado. El presupuesto es la cantidad máxima de dinero que desea gastar para una orden de inserción. En el caso de los pedidos de inserción con presupuesto ilimitado, el presupuesto está limitado por el límite de crédito. En ese caso, el presupuesto diario de cada campaña determina el gasto máximo.

Nota: No se admite la adición o actualización de pedidos de inserción ilimitados. SpendCapAmount funciona en modo de solo lectura.

Agregar: Obligatorio
Actualizar: Opcional		 doble
StartDate Fecha en la que la orden de inserción puede comenzar a acumular cargos. La fecha de inicio debe ser posterior a la fecha actual.

La fecha se almacena en hora universal coordinada (UTC). Solo se usan el mes, el día y el año de la cadena especificada. Si especifica la hora, los minutos y los segundos de una fecha, se omitirán.

Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos.

Agregar: Obligatorio
Actualizar: Opcional. Solo puede actualizar la fecha de inicio a través de este elemento si status es PendingUserReview. Si la fecha de inicio ya ha pasado, no puede cambiarla.

Si intenta actualizar StartDate o EndDate de un orden de inserción que forma parte de una serie periódica , la API devolverá un error.		 dateTime
Estado Estado del orden de inserción.

Agregar: Solo lectura. Los pedidos de inserción que cree se establecen inmediatamente en Active, NotStarted o Declined.
Actualizar: Es necesario para aprobar o rechazar un pedido de inserción que aún no está aprobado, o cancelar un pedido de inserción que ya se ha aprobado. Solo puede aprobar o rechazar a través de este elemento si el estado actual está establecido en PendingUserReview. Solo se puede cancelar a través de este elemento si el estado actual está establecido en Activo, Agotado o NotStarted. Una vez que el estado del pedido de inserción es Active, Exhaust, Expired o NotStarted, puede realizar nuevos cambios o aprobar o rechazar los cambios pendientes actuales a través del elemento PendingChanges .

Al llamar a UpdateInsertionOrder , puede establecer este elemento Status o modificar otros elementos de este objeto, pero no puede cambiar el estado en paralelo con otras actualizaciones de propiedades.

Si actualiza el estado de un orden de inserción que forma parte de una serie periódica, la actualización de estado se aplicará a todos los pedidos de inserción de la serie.		 InsertionOrderStatus

Requisitos

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

Usado por

AddInsertionOrder
SearchInsertionOrders
UpdateInsertionOrder