Compartilhar via

InsertionOrder Data Object – Faturação do Cliente

  • Artigo

Uma ordem de inserção é um contrato que estabelece o montante máximo que irá gastar na sua conta durante um determinado período de tempo. Se tiver a faturação mensal configurada para a sua conta, tem de ter uma ordem de inserção ativa para que os anúncios sejam elegíveis para entrega. Continua a controlar os gastos com o orçamento da sua campanha e só lhe será cobrado o que acumular. Por exemplo, se tiver uma ordem de inserção de um mês por 5 000 $ e tiver acumulado apenas 4.500 $ em custos durante o período de faturação, só iremos deduzir 4500 $ do orçamento da sua ordem de inserção.

Aviso

O orçamento da ordem de inserção aplica-se apenas aos gastos com anúncios, o que é uma distinção importante se a sua empresa estiver num país/região onde serviços online são tributadas. Se tiver um limite orçamental rigoroso, poderá ter de ter em conta os impostos no orçamento da sua ordem de inserção. Para saber mais sobre os requisitos fiscais na sua localização empresarial, consulte o artigo de ajuda informações sobre impostos ou IVA .

A maioria dos elementos deste objeto só pode ser definida antes de a ordem de inserção ser aprovada, ou seja, se o Estado estiver definido como PendingUserReview. Nesse caso, pode fazer novas alterações ou aprovar ou recusar a ordem de inserção através de elementos deste objeto. Assim que o Estado da ordem de inserção estiver Ativo, Esgotado, Expirado ou Não Iniciado, pode fazer novas alterações ou aprovar ou recusar as alterações pendentes atuais através do elemento Alterações Pendentes . Se o Estado da ordem de inserção for Cancelado ou Recusado, não poderá atualizar a ordem de inserção.

Nota

A operação SearchInsertionOrders devolverá até 24 ordens de inserção por série periódica.

Pode obter, mas com poucas exceções não pode adicionar ou atualizar uma série de encomendas de inserção através da API de Anúncios do Bing. Utilize o elemento IsInSeries para determinar se a ordem de inserção está numa série periódica.

  • Se tentar atualizar o StartDate ou o EndDate de uma ordem de inserção que faça parte de uma série periódica, a API devolverá um erro.
  • Se atualizar o Estado de uma ordem de inserção que faz parte de uma série periódica, a atualização de estado será aplicada a todas as encomendas de inserção na série.

Para gerir encomendas de inserção periódica na aplicação Web Microsoft Advertising, consulte o artigo de ajuda Como devo proceder para criar e editar uma ordem de inserção?.

Sintaxe

<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

O objeto InsertionOrder tem os seguintes 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 Descrição Tipo de Dados
AccountId O identificador da conta à qual se aplica a ordem de inserção.

Não é possível atualizar o identificador da conta depois de criar a ordem de inserção.

Adicionar: Necessário
Atualização: Só de leitura		 long
AccountNumber O número de conta gerado pelo sistema que é utilizado para identificar a conta na aplicação Web Microsoft Advertising. O número da conta tem o formulário xxxxxxxx, em que xxxxxxxx é uma série de oito carateres alfanuméricos.

Adicionar: Só de leitura
Atualização: Só de leitura		 cadeia
BookingCountryCode Reservado para utilização interna.

Adicionar: Necessário para algumas contas; Opcional para algumas contas.
Atualização: Só de leitura		 cadeia
BudgetRemaining O saldo de execução da ordem de inserção.

O valor do saldo em execução é inicialmente o mesmo que SpendCapAmount e, em seguida, diminui sempre que um anúncio na conta é servido.

Este elemento está vazio se a ordem de inserção tiver um orçamento ilimitado.

Adicionar: Só de leitura
Atualização: Só de leitura		 duplo
BudgetRemainingPercent A percentagem do orçamento restante para a ordem de inserção.

Este valor é calculado como BudgetRemaining / SpendCapAmount.

Este elemento está vazio se a ordem de inserção tiver um orçamento ilimitado.

Adicionar: Só de leitura
Atualização: Só de leitura		 duplo
Orçamento Gasto O saldo restante da ordem de inserção.

O saldo restante é inicialmente 0 (zero) e, em seguida, aumenta para o SpendCapAmount sempre que um anúncio na conta é servido.

Este elemento está vazio se a ordem de inserção tiver um orçamento ilimitado.

Adicionar: Só de leitura
Atualização: Só de leitura		 duplo
BudgetSpentPercent A percentagem do orçamento gasto para a ordem de inserção.

Este valor é calculado como BudgetSpent / SpendCapAmount.

Este elemento está vazio se a ordem de inserção tiver um orçamento ilimitado.

Adicionar: Só de leitura
Atualização: Só de leitura		 duplo
Comentar Uma descrição da ordem de inserção. A descrição está limitada a 100 carateres.

Adicionar: Opcional
Atualização: Opcional		 cadeia
DataDadosEncom efeitos Finais A data em que a ordem de inserção expira. A data de fim tem de ser posterior à data de início.

A data é armazenada na Hora Universal Coordenada (UTC). Apenas são utilizados o mês, o dia e o ano da cadeia especificada. Se especificar a hora, os minutos e os segundos de uma data, estes serão ignorados.

Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.

Nota: se a ordem de inserção não tiver data de fim, EndDate estará vazio. A adição ou atualização de encomendas de inserção ilimitadas não é suportada. O EndDate funciona no modo só de leitura.

Adicionar: Necessário
Atualização: Opcional. Se tentar atualizar o StartDate ou o EndDate de uma ordem de inserção que faça parte de uma série periódica, a API devolverá um erro.		 dateTime
ID Um identificador gerado pelo sistema que identifica a ordem de inserção.

Adicionar: Só de leitura
Atualização: Só de leitura e Obrigatório		 long
IsEndless Determina se a ordem de inserção não tem data de fim.

Se o valor for Verdadeiro, a ordem de inserção não terá data de fim e o EndDate desta ordem de inserção será ignorado.

Adicionar: Opcional
Atualização: Opcional		 booleano
Série IsInSeries Determina se a ordem de inserção está numa série periódica.

Se o valor for Verdadeiro, a ordem de inserção faz parte de uma série periódica. Se tentar atualizar o StartDate ou o EndDate de uma ordem de inserção que faça parte de uma série periódica, a API devolverá um erro. Se atualizar o Estado de uma ordem de inserção que faz parte de uma série periódica, a atualização de estado será aplicada a todas as encomendas de inserção na série.

Adicionar: Só de leitura
Atualização: Só de leitura		 booleano
IsUnlimited Determina se a ordem de inserção tem um orçamento ilimitado.

Se o valor for Verdadeiro, a ordem de inserção terá um orçamento ilimitado e o SpendCapAmount desta ordem de inserção será ignorado.

Adicionar: Opcional
Atualização: Opcional		 booleano
LastModifiedByUserId Um identificador do último utilizador a atualizar a ordem de inserção.

Adicionar: Só de leitura
Atualização: Só de leitura		 long
LastModifiedTime A data e hora em que a ordem de inserção foi atualizada pela última vez.

A data é armazenada na Hora Universal Coordenada (UTC).

Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.

Adicionar: Só de leitura
Atualização: Só de leitura		 dateTime
Nome O nome amigável que pode ser utilizado para referenciar esta ordem de inserção.

O nome pode conter um máximo de 100 carateres.

O nome não tem de ser exclusivo em comparação com outras encomendas de inserção para o cliente.

Adicionar: Opcional
Atualização: Opcional		 cadeia
NotificationThreshold Uma percentagem do orçamento que foi gasto. Especifique a percentagem como um valor de 0 a 100. A notificação é enviada quando o limiar é atingido. Por exemplo, se definir o limiar para 70, o Serviço de faturação envia uma notificação quando tiver gasto 70% do orçamento.

Se não quiser receber a notificação, defina como NULL.

Reservado para utilização interna.

Adicionar: Opcional
Atualização: Opcional		 duplo
Alterações Pendentes Pode ser utilizado para gerir as alterações de uma ordem de inserção aprovada com o estado definido como Ativo, Esgotado, Expirado ou Não Iniciado.

Adicionar: Só de leitura
Atualização: Opcional		 InsertionOrderPendingChanges
PurchaseOrder Um valor de nota de encomenda que pode ser utilizado para referenciar esta ordem de inserção em faturas mensais. Este valor será impresso como a nota de encomenda nas faturas mensais.

A nota de encomenda pode conter um máximo de 50 carateres.

Adicionar: Opcional
Atualização: Opcional		 cadeia
ReferenceId Reservado apenas para utilização interna.

Adicionar: Opcional
Atualização: Opcional		 long
SeriesFrequencyType Determina como uma encomenda se repete na série.

Os valores possíveis são Mensal, BiMonthly, Trimestral e Anual.

Adicionar: Só de leitura
Atualização: Só de leitura		 cadeia
SeriesName O nome da série de ordem de inserção periódica.

O nome pode conter um máximo de 100 carateres.

Mesmo que a ordem de inserção seja posteriormente removida da série periódica, este elemento continuará a refletir o nome da série em que foi criada.

Adicionar: Só de leitura
Atualização: Só de leitura		 cadeia
SpendCapAmount O orçamento para esta ordem de inserção. O orçamento é um limite rígido. Quando a conta atinge este limite e não existe outra ordem de inserção disponível, o valor do estado do ciclo de vida da conta é definido como Pausa.

Este elemento está vazio se a ordem de inserção tiver um orçamento ilimitado. O orçamento é a quantidade máxima de dinheiro que pretende gastar para uma ordem de inserção. Para encomendas de inserção com orçamento ilimitado, o orçamento está vinculado ao limite de crédito. Nesse caso, o orçamento diário de cada campanha determina o máximo de gastos.

Nota: a adição ou atualização de encomendas de inserção ilimitadas não é suportada. O SpendCapAmount funciona no modo só de leitura.

Adicionar: Necessário
Atualização: Opcional		 duplo
Data De Início A data em que a ordem de inserção pode começar a acumular custos. A data de início tem de ser posterior à data atual.

A data é armazenada na Hora Universal Coordenada (UTC). Apenas são utilizados o mês, o dia e o ano da cadeia especificada. Se especificar a hora, os minutos e os segundos de uma data, estes serão ignorados.

Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.

Adicionar: Necessário
Atualização: Opcional. Só pode atualizar a data de início através deste elemento se o Estado for PendingUserReview. Se a data de início já tiver passado, não poderá alterá-la.

Se tentar atualizar o StartDate ou o EndDate de uma ordem de inserção que faça parte de uma série periódica, a API devolverá um erro.		 dateTime
Estado O estado da ordem de inserção.

Adicionar: Só de leitura. As encomendas de inserção que criar são imediatamente definidas como Ativas, Não Iniciados ou Recusadas.
Atualização: Necessário para aprovar ou recusar uma ordem de inserção que ainda não foi aprovada ou cancelar uma ordem de inserção que já tenha sido aprovada. Só pode aprovar ou recusar através deste elemento se o estado atual estiver definido como PendingUserReview. Só pode cancelar através deste elemento se o estado atual estiver definido como Ativo, Esgotado ou Não Iniciado. Assim que o estado da ordem de inserção for Ativo, Esgotado, Expirado ou Não Iniciado, pode fazer novas alterações ou aprovar ou recusar as alterações pendentes atuais através do elemento Alterações Pendentes .

Quando chama UpdateInsertionOrder , pode definir este elemento Estado ou modificar outros elementos deste objeto, mas não pode alterar o estado em paralelo com outras atualizações de propriedade.

Se atualizar o Estado de uma ordem de inserção que faz parte de uma série periódica, a atualização de estado será aplicada a todas as encomendas de inserção na série.		 InsertionOrderStatus

Requisitos

Serviço: CustomerBillingService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13/Entities

Utilizado Por

AddInsertionOrder
SearchInsertionOrders
UpdateInsertionOrder