Partilhar via

Operação de Serviço AddInsertionOrder – Faturação do Cliente

  • Artigo

Adiciona uma ordem de inserção à conta especificada.

Elementos do Pedido

O objeto AddInsertionOrderRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
InsertionOrder Uma ordem de inserção para adicionar à conta. InsertionOrder

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
AuthenticationToken O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto AddInsertionOrderResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
CreateTime Identifica a hora do servidor em UTC quando a ordem de inserção foi adicionada. dateTime
InsertionOrderId Um valor longo que representa o identificador da ordem de inserção que foi adicionada. Longo

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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">AddInsertionOrder</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <AddInsertionOrderRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <InsertionOrder xmlns:e147="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e147:AccountId>ValueHere</e147:AccountId>
        <e147:BookingCountryCode i:nil="false">ValueHere</e147:BookingCountryCode>
        <e147:Comment i:nil="false">ValueHere</e147:Comment>
        <e147:EndDate i:nil="false">ValueHere</e147:EndDate>
        <e147:Id i:nil="false">ValueHere</e147:Id>
        <e147:LastModifiedByUserId i:nil="false">ValueHere</e147:LastModifiedByUserId>
        <e147:LastModifiedTime i:nil="false">ValueHere</e147:LastModifiedTime>
        <e147:NotificationThreshold i:nil="false">ValueHere</e147:NotificationThreshold>
        <e147:ReferenceId i:nil="false">ValueHere</e147:ReferenceId>
        <e147:SpendCapAmount i:nil="false">ValueHere</e147:SpendCapAmount>
        <e147:StartDate i:nil="false">ValueHere</e147:StartDate>
        <e147:Name i:nil="false">ValueHere</e147:Name>
        <e147:Status i:nil="false">ValueHere</e147:Status>
        <e147:PurchaseOrder i:nil="false">ValueHere</e147:PurchaseOrder>
        <e147:PendingChanges i:nil="false">
          <e147:Comment i:nil="false">ValueHere</e147:Comment>
          <e147:EndDate i:nil="false">ValueHere</e147:EndDate>
          <e147:RequestedByUserId i:nil="false">ValueHere</e147:RequestedByUserId>
          <e147:ModifiedDateTime i:nil="false">ValueHere</e147:ModifiedDateTime>
          <e147:NotificationThreshold i:nil="false">ValueHere</e147:NotificationThreshold>
          <e147:ReferenceId i:nil="false">ValueHere</e147:ReferenceId>
          <e147:SpendCapAmount i:nil="false">ValueHere</e147:SpendCapAmount>
          <e147:StartDate i:nil="false">ValueHere</e147:StartDate>
          <e147:Name i:nil="false">ValueHere</e147:Name>
          <e147:PurchaseOrder i:nil="false">ValueHere</e147:PurchaseOrder>
          <e147:ChangeStatus i:nil="false">ValueHere</e147:ChangeStatus>
        </e147:PendingChanges>
        <e147:AccountNumber i:nil="false">ValueHere</e147:AccountNumber>
        <e147:BudgetRemaining i:nil="false">ValueHere</e147:BudgetRemaining>
        <e147:BudgetSpent i:nil="false">ValueHere</e147:BudgetSpent>
        <e147:BudgetRemainingPercent i:nil="false">ValueHere</e147:BudgetRemainingPercent>
        <e147:BudgetSpentPercent i:nil="false">ValueHere</e147:BudgetSpentPercent>
        <e147:SeriesName i:nil="false">ValueHere</e147:SeriesName>
        <e147:IsInSeries i:nil="false">ValueHere</e147:IsInSeries>
        <e147:SeriesFrequencyType i:nil="false">ValueHere</e147:SeriesFrequencyType>
        <e147:IsUnlimited i:nil="false">ValueHere</e147:IsUnlimited>
        <e147:IsEndless i:nil="false">ValueHere</e147:IsEndless>
      </InsertionOrder>
    </AddInsertionOrderRequest>
  </s:Body>
</s:Envelope>

Soap de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
    <AddInsertionOrderResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <InsertionOrderId>ValueHere</InsertionOrderId>
      <CreateTime>ValueHere</CreateTime>
    </AddInsertionOrderResponse>
  </s:Body>
</s:Envelope>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

public async Task<AddInsertionOrderResponse> AddInsertionOrderAsync(
	InsertionOrder insertionOrder)
{
	var request = new AddInsertionOrderRequest
	{
		InsertionOrder = insertionOrder
	};

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

static AddInsertionOrderResponse addInsertionOrder(
	InsertionOrder insertionOrder) throws RemoteException, Exception
{
	AddInsertionOrderRequest request = new AddInsertionOrderRequest();

	request.setInsertionOrder(insertionOrder);

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

static function AddInsertionOrder(
	$insertionOrder)
{

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

	$request = new AddInsertionOrderRequest();

	$request->InsertionOrder = $insertionOrder;

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

response=customerbilling_service.AddInsertionOrder(
	InsertionOrder=InsertionOrder)

Requisitos

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

URL do Pedido

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/InsertionOrder

Elementos do Pedido

O objeto AddInsertionOrderRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
InsertionOrder Uma ordem de inserção para adicionar à conta. InsertionOrder

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
Autorização O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto AddInsertionOrderResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
CreateTime Identifica a hora do servidor em UTC quando a ordem de inserção foi adicionada. dateTime
InsertionOrderId Um valor longo que representa o identificador da ordem de inserção que foi adicionada. Longo

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir JSON

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

{
  "InsertionOrder": {
    "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"
  }
}

JSON de Resposta

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.

{
  "InsertionOrderId": "LongValueHere",
  "CreateTime": "ValueHere"
}

Sintaxe de Código

Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

public async Task<AddInsertionOrderResponse> AddInsertionOrderAsync(
	InsertionOrder insertionOrder)
{
	var request = new AddInsertionOrderRequest
	{
		InsertionOrder = insertionOrder
	};

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

static AddInsertionOrderResponse addInsertionOrder(
	InsertionOrder insertionOrder) throws RemoteException, Exception
{
	AddInsertionOrderRequest request = new AddInsertionOrderRequest();

	request.setInsertionOrder(insertionOrder);

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

static function AddInsertionOrder(
	$insertionOrder)
{

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

	$request = new AddInsertionOrderRequest();

	$request->InsertionOrder = $insertionOrder;

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

response=customerbilling_service.AddInsertionOrder(
	InsertionOrder=InsertionOrder)