Detalhes de Conexão do Microsoft Advertising¶

Introdução¶

Versão do conector

Esta documentação é baseada na versão 21.0.8383 do conector.

Começando¶

Suporte à versão do Bing Ads

O conector modela relatórios e outras entidades na API do Bing Ads como exibições relacionais.

Estabelecendo uma Conexão¶

Conectando-se ao Bing Ads¶

Você precisa registrar uma conta do Bing Ads, obter um token de desenvolvedor e autenticar usando OAuth para se conectar às APIs do Bing Ads.

Registrar uma Conta do Bing Ads¶

Conclua as etapas a seguir para se inscrever em uma conta do Bing Ads e obter o CustomerId e (opcional) AccountId:

1. Inscreva-se em uma conta do Bing Ads no aplicativo da Web do Bing Ads ou no Site Sandbox para uma conta de sandbox.
2. Selecione Settings > Accounts and Billing e selecione uma única conta. O AccountId e CustomerId (cid) são exibidos na página da conta e no URL da página.

Obtenha um Token de Desenvolvedor¶

Para usar as APIs do Bing Ads, você deve ter um DeveloperToken Em adição ao CustomerId. Você deve ter a papel Super Admin no Bing Ads para criar um token de desenvolvedor, embora não precise de permissões especiais para usar o token.

1. Faça login no Portal do desenvolvedor do Bing Ads como um usuário de conta da Microsoft com a papel de superadministrador do Bing Ads.
2. Clique em Request Token e anote seu token de desenvolvedor. Você irá configurá-lo no DeveloperToken propriedade de conexão.

Autenticar Via Autenticação OAuth¶

As APIs do Bing Ads usam o padrão OAuth 2. Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• DeveloperToken: Defina como o token que você gerou na seção Obtendo um token de desenvolvedor.
• AccountId: Defina o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Settings > Accounts and Billing > Your Account > Account.
• CustomerId: Defina o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Settings > Accounts and Billing > Your Account > Customer.
• UseSandbox: Definido como true para usar uma conta sandbox do Bing Ads.

Quando você se conecta, o conector abre o endpoint OAuth do Bing Ads em seu navegador padrão. Faça login e conceda permissões ao conector. O conector então conclui o processo OAuth.

Consulte Usando autenticação OAuth para outros fluxos de autenticação OAuth.

Usando Autenticação OAuth¶

OAuth exige que o usuário autenticado interaja com o Bing Ads usando o navegador. O conector facilita isso de várias maneiras, conforme descrito abaixo.

Credenciais Incorporadas¶

Consulte Credenciais incorporadas para se conectar com as credenciais incorporadas do conector e pule a criação de um aplicativo OAuth personalizado. O conector possui credenciais OAuth incorporadas para sandbox e produção.

Credenciais Personalizadas¶

Em vez de se conectar com as credenciais incorporadas do conector, você pode registrar um aplicativo para obter o OAuthClientId e OAuthClientSecret.

Quando Criar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Bing Ads e você pode se conectar com suas credenciais incorporadas. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do Bing Ads para conceder permissões ao conector.

Criando um Aplicativo OAuth Personalizado¶

Consulte Criando um aplicativo OAuth personalizado para um procedimento.

Credenciais Incorporadas¶

Autenticar Usando as Credenciais OAuth Incorporadas¶

Registrar uma Conta do Bing Ads¶

Siga as etapas abaixo para se inscrever em uma conta do Bing Ads e obter o CustomerId e AccountId:

1. Inscreva-se em uma conta do Bing Ads no aplicativo da Web do Bing Ads ou no Site Sandbox para uma conta de sandbox.
2. Clique em Configurações -> Contas e Faturamento e selecione uma única conta. O AccountId e CustomerId (cid) são exibidos na página da conta e no URL da página.

Obtenha um Token de Desenvolvedor¶

Para usar as APIs do Bing Ads, você deve ter um DeveloperToken Em adição ao CustomerId e AccountId. Você deve ter a papel Super Admin no Bing Ads para criar um token de desenvolvedor, embora não precise de permissões especiais para usar o token.

1. Faça login no Portal do desenvolvedor do Bing Ads como um usuário de conta da Microsoft com a papel de superadministrador do Bing Ads.
2. Clique no botão Solicitar token e anote seu token de desenvolvedor. Você irá configurá-lo no DeveloperToken propriedade de conexão.

Autenticação de Desktop com o Aplicativo OAuth Incorporado¶

Você pode se conectar sem definir nenhuma propriedade de conexão para suas credenciais de usuário. Depois de definir o seguinte, você está pronto para se conectar:

• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads. BBD37VB98 pode ser usado para contas sandbox.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth.

1. Extrai o token de acesso do URL de retorno de chamada e autentica as solicitações.
2. Obtém um novo token de acesso quando o antigo expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Credenciais Personalizadas¶

Quando Usar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Bing Ads e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Bing Ads para conceder permissões ao conector.

Registrando uma Conta do Bing Ads¶

Siga as etapas abaixo para se inscrever em uma conta do Bing Ads e obter o CustomerId e AccountId:

1. Inscreva-se em uma conta do Bing Ads no aplicativo da Web do Bing Ads ou no Site Sandbox para uma conta de sandbox.
2. Clique em Configurações -> Contas e Faturamento e selecione uma única conta. O AccountId e CustomerId (cid) são exibidos na página da conta e no URL da página.

Obtendo um Token de Desenvolvedor¶

Para usar as APIs do Bing Ads, você deve ter um DeveloperToken Em adição ao CustomerId e AccountId. Você deve ter a papel Super Admin no Bing Ads para criar um token de desenvolvedor, embora não precise de permissões especiais para usar o token.

1. Faça login no Portal do desenvolvedor do Bing Ads como um usuário de conta da Microsoft com a papel de superadministrador do Bing Ads.
2. Clique no botão Solicitar token e anote seu token de desenvolvedor. Você irá configurá-lo no DeveloperToken propriedade de conexão.

Autenticação de Desktop com um Aplicativo OAuth Personalizado¶

Siga as etapas abaixo para autenticar com as credenciais de um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado.

Obtenha e Atualize o Token de Acesso OAuth¶

Depois de definir o seguinte, você está pronto para se conectar:

• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• CallbackURL: Defina isso para o URI de redirecionamento definido quando você registrou seu aplicativo.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar a repetição da troca OAuth e definir manualmente o OAuthAccessToken.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector então conclui o processo OAuth:

1. Extrai o token de acesso da URL de retorno de chamada e autentica as solicitações.
2. Atualiza o token de acesso quando ele expira.
3. Salva valores OAuth em OAuthSettingsLocation para ser persistido nas conexões.

Máquinas Sem Cabeça¶

Usando OAuth em uma Máquina Sem Cabeça¶

Para criar fontes de dados do Bing Ads em servidores headless ou outras máquinas nas quais o conector não pode abrir um navegador, você precisa se autenticar em outra máquina. A autenticação é um processo de duas etapas.

1. Ao invés de instalar o conector em outra máquina, você pode seguir os passos abaixo para obter o OAuthVerifier valor. Ou você pode instalar o conector em outra máquina e transferir os valores de autenticação OAuth, depois de autenticar por meio do fluxo normal baseado em navegador.
2. Em seguida, você pode configurar o conector para atualizar automaticamente o token de acesso da máquina sem periféricos.

Você pode seguir o fluxo de autenticação OAuth headless usando as credenciais OAuth incorporadas do conector ou usando as credenciais OAuth para seu aplicativo OAuth personalizado.

Usando as Credenciais OAuth Incorporadas¶

Obtenha um código verificador

Siga as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade da conexão:

1. Clique no link a seguir para abrir o endpoint OAuth do Bing Ads em seu navegador.
2. Efetue login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth.

• OAuthVerifier: Defina isso para o código do verificador.
• InitiateOAuth: Configure para ATUALIZAR.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Teste a conexão para autenticar no navegador. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Configure para ATUALIZAR.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Usando as Credenciais para um Aplicativo OAuth Personalizado¶

Crie um aplicativo OAuth personalizado

A criação de um aplicativo OAuth customizado é opcional no fluxo OAuth headless; você pode ignorar a criação de um aplicativo conectando-se com as credenciais OAuth incorporadas do conector. Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no Bing Ads para conceder permissões ao conector.

Consulte Criando um aplicativo OAuth personalizado para um procedimento. Você pode seguir os procedimentos abaixo para autenticar e conectar-se aos dados.

Obtenha um código verificador

Defina as seguintes propriedades na máquina sem periféricos:

• InitiateOAuth: Defina como DESLIGADO.
• OAuthClientId: Defina isso como o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Você pode seguir as etapas abaixo para autenticar em outra máquina e obter o OAuthVerifier propriedade de conexão.

1. Chame GetOAuthAuthorizationURL procedimento armazenado* com o parâmetro de entrada CallbackURL definido para o URI de redirecionamento exato que você especificou nas configurações do aplicativo.
2. Abra o URL retornado em um navegador. Faça login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador.
3. Salve o valor do código do verificador. Você definirá isso no OAuthVerifier propriedade de conexão.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.
• InitiateOAuth: Configure para ATUALIZAR.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Conecte-se aos dados

Depois que o arquivo de configurações OAuth for gerado, defina as seguintes propriedades para se conectar aos dados:

• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao provedor para ativar a atualização automática do token de acesso.
• InitiateOAuth: Configure para ATUALIZAR.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Configurações de transferência OAuth

Siga as etapas abaixo para instalar o conector em outra máquina, autenticar e depois transferir os valores OAuth resultantes.

Em uma segunda máquina, instale o conector e conecte-se com o seguinte conjunto de propriedades:

• OAuthSettingsLocation: Defina isso como um arquivo de texto gravável.
• InitiateOAuth: Defina como GETANDREFRESH.
• OAuthClientId: Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• CallbackURL: Defina isso para o URI de redirecionamento que você especificou nas configurações do aplicativo.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Teste a conexão para autenticar. Os valores de autenticação resultantes são gravados, criptografados, no caminho especificado por OAuthSettingsLocation. Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos. Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Configure para ATUALIZAR.
• OAuthClientId: Defina isso como a chave do consumidor nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do consumidor nas configurações do aplicativo.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.
• DeveloperToken: Defina como o token que você gerou no Portal do desenvolvedor do Bing Ads.
• AccountId: Defina como o valor de ID da conta encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Conta.
• CustomerId: Defina como o valor de ID do cliente encontrado no aplicativo da Web do Bing Ads, em Configurações -> Contas e Faturação -> Sua conta -> Cliente.

Criando um Aplicativo OAuth Personalizado¶

Quando Criar um Aplicativo OAuth Personalizado¶

A criação de um aplicativo OAuth personalizado é opcional, pois o conector já está registrado no Bing Ads e você pode se conectar com suas credenciais incorporadas.

Talvez você queira criar um aplicativo OAuth personalizado para alterar as informações exibidas quando os usuários fazem login no endpoint OAuth do Bing Ads para conceder permissões ao conector.

Siga as etapas abaixo para criar um aplicativo OAuth personalizado e obter as propriedades de conexão em um fluxo de autenticação OAuth específico.

Crie um Aplicativo OAuth Personalizado: Área de Trabalho¶

1. Se ainda não o fez, inscreva-se em uma conta do Bing Ads no aplicativo da Web do Bing Ads ou no Site Sandbox para uma conta de sandbox.
2. Acesse o portal do Azure (portal de teste do Azure para contas de área restrita) e faça login com suas credenciais de conta da Microsoft quando solicitado.
3. Em Azure Active Directory --> Registros de aplicativos, clique em Novo registro.
4. Forneça o nome do aplicativo e selecione um tipo de conta compatível apropriado. Não selecionar para permitir contas pessoais da Microsoft impedirá a autenticação de usuários com contas pessoais.
5. Na seção URI de redirecionamento, você deve definir um URL apropriado. Para aplicativos de desktop, um valor como "http://localhost:33333 ou outra porta de sua escolha pode ser configurada.
6. Registre seu aplicativo e anote seu ID de aplicativo (cliente). Você vai usá-lo como o OAuthClientId valor no fluxo de concessão OAuth.
7. Na seção Certificados e segredos, clique em Novo segredo do cliente para gerar um segredo do cliente e anote o valor resultante. Você vai usá-lo como o OAuthClientSecret valor.

Características Avançadas¶

Esta seção detalha uma seleção de recursos avançados do conector do Bing Ads.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário¶

O Conector Jitterbit para Bing Ads permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração¶

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma visualização.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a visualização.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM AdGroups WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário¶

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário¶

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resultando na consultar efetiva à fonte:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL¶

Personalizando a Configuração SSL¶

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados¶

O Jitterbit Connector for Bing Ads modela entidades na API do Bing Ads como exibições de banco de dados e procedimentos armazenados. Eles são definidos em arquivos de esquema, que são arquivos de configuração simples baseados em texto.

As seções a seguir fornecem informações sobre a execução de SQL para os objetos de API disponíveis. O conector transfere o máximo possível do processamento da instrução SELECT para o Bing Ads e processa o restante da consultar na memória; As limitações e os requisitos da API estão documentados nesta seção.

Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Visualizações

Os objetos Bing Ads do conector como Visualizações, incluindo relatórios.

Você pode consultar relatórios com base em uma agregação e período de tempo. O período padrão é este ano; para alterar o período de tempo, consulte a seção Filtro de tempo a seguir.

Ao recuperar apenas algumas colunas do relatório, todas as colunas marcadas como 'Selecionar requisito' e pelo menos uma das colunas marcadas como 'Métrica' devem ser selecionadas para emitir uma solicitação de relatório válida. Por outro lado, se você estiver recuperando todas as colunas, o driver assumirá como padrão a inclusão das colunas mínimas necessárias na solicitação.

Consultar Agregações de Relatórios¶

Por padrão, os dados do relatório serão agregados por todo o tempo especificado do relatório e o relatório não incluirá uma coluna de período de tempo. Os dados, por padrão, serão recuperados apenas para o último mês. Se você deseja alterar esse comportamento, consulte o 'Specifying a Time Filter' seção abaixo.

Além disso, você pode agregar os dados do relatório selecionando uma das seguintes colunas de agregação:

• Daily: Cada linha do relatório identifica o mês, dia e ano em que ocorreu a transação. Os dados do relatório serão agregados a cada dia. O relatório incluirá uma coluna denominada Diariamente que contém o dia formatado como aaaa-mm-dd.

  SELECT Daily, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• DayOfWeek: Cada linha do relatório identifica o dia da semana em que ocorreu a transação. Os dados do relatório serão agregados por cada um dos sete dias da semana. O relatório incluirá uma coluna chamada DayOfWeek e os valores possíveis são 1 - 7, onde 1 representa domingo e 7 representa sábado.

  Se o tempo do relatório abranger várias semanas, os dados de desempenho de todas as semanas para um determinado dia da semana serão agregados em uma linha. Por exemplo, se a Campanha A tiver 5 impressões toda segunda-feira (dia 2) durante cada uma das 3 semanas incluídas no intervalo de tempo do relatório, o relatório incluirá uma linha com DayOfWeek definido como 2 e impressões nessa linha totalizando 15.

  SELECT DayOfWeek, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• Hourly: Cada linha do relatório identifica a hora em que ocorreu a transação. Os dados do relatório serão agregados a cada hora do dia. O relatório incluirá uma coluna chamada Hourly e os valores possíveis são 0 - 23.

  SELECT Hourly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• HourOfDay: Cada linha do relatório identifica a hora do dia em que ocorreu a transação. Os dados do relatório serão agregados por cada uma das 24 horas em todos os dias. O relatório incluirá uma coluna chamada HourOfDay e os valores possíveis são 0 - 23.

  Se o tempo do relatório abranger vários dias, os dados de desempenho de todos os dias para uma determinada hora serão agregados em uma linha. Por exemplo, se a Campanha A tiver 5 impressões durante a hora 7 em cada um dos 3 dias incluídos no intervalo de tempo do relatório, o relatório incluirá uma linha com impressões para HourOfDay totalizando 15.

  SELECT HourOfDay, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• Monthly: Cada linha do relatório identifica o mês em que ocorreu a transação. Os dados do relatório serão agregados a cada mês. O relatório incluirá uma coluna chamada Mensal que contém o primeiro dia do mês formatado como aaaa-mm-dd.

  SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• Weekly: Cada linha do relatório identifica a semana em que ocorreu a transação. Os dados do relatório serão agregados a cada semana. O relatório incluirá uma coluna chamada Semanal que contém a data do domingo para cada semana formatada como aaaa-mm-dd.

  SELECT Weekly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

• Yearly: Cada linha do relatório identifica o ano em que ocorreu a transação. Os dados do relatório serão agregados a cada ano. O relatório incluirá uma coluna chamada Anual que contém o ano formatado como aaaa.

  SELECT Yearly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [AccountPerformanceReport ]
  

Especificando um Filtro de Tempo¶

Você pode especificar um intervalo de datas personalizado ou especificar um intervalo de datas predefinido.

• Para pesquisar em um intervalo de datas predefinido, defina a pseudocoluna DatePreset na cláusula WHERE com um dos seguintes valores: Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear ou LastYear. O valor DatePreset padrão é "ThisYear".

  SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [Relatório de desempenho da conta] WHERE DatePreset = 'LastYear'
  

• Para especificar um intervalo de datas personalizado, especifique as pseudocolunas StartDate e EndDate na cláusula WHERE.

  SELECT Monthly, AccountName, AccountStatus, Impressions, Clicks, ConversionRate  FROM [Relatório de desempenho da conta] WHERE StartDate = '2014-01-01' AND EndDate = '2017-09-19'
  

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados. Eles podem ser usados para pesquisar, atualizar e modificar informações na fonte de dados.

Visualizações¶

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Exibições de Anúncios do Bing¶

Relatório de Desempenho da Conta¶

Use este relatório para observar o desempenho e as tendências da conta a longo prazo.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Contas¶

Consulte as contas disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

As pesquisas nessa tabela são processadas no lado do cliente pelo conector; a consultar a seguir é processada no lado do servidor.

SELECT * FROM [Accounts ]

A execução da consultar no lado do cliente pode ser desativada definindo SupportEnhancedSQL para falso, caso em que qualquer consultar que não seja SELECT * retornará um erro.

Colunas¶

Relatório de Desempenho do AdDynamicText¶

Use este relatório para identificar quais strings de texto dinâmico estão tendo um bom desempenho e quais strings você deve considerar mudar.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

AdExtensionByAdReport¶

Use esse relatório para comparar o desempenho de diferentes versões de suas extensões de anúncio com cada anúncio.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatório de Extensão de Anúncio por Palavra-chave¶

Use esse relatório para comparar o desempenho de diferentes versões de suas extensões de anúncio para cada palavra-chave.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatório de Detalhes da Extensão de Anúncios¶

Use esse relatório para descobrir a eficácia de itens de extensão de anúncio individuais, por exemplo, cada link de uma extensão de sitelink.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatório de Desempenho do Grupo de Anúncios¶

Use esse relatório para comparar mais amplamente as estatísticas de desempenho de entrega por grupo de anúncios, campanha ou atributos de conta, em vez de no nível da palavra-chave.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Grupos de Anúncios¶

Consulte os AdGroups disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

Você deve especificar a coluna CampaignId na cláusula WHERE para consultar esta tabela. O conector usará a API do Bing Ads para filtrar os resultados por CampaignId enquanto o restante do filtro é executado no lado do cliente no conector.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM [Grupos de anúncios] WHERE CampaignId = '234505536'

A execução da consultar no lado do cliente pode ser desativada definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa com colunas na cláusula WHERE diferente de CampaignId causará um erro.

Colunas¶

Relatório de Desempenho de Anúncios¶

Use esse relatório para ajudá-lo a determinar quais anúncios levam a cliques e conversões e quais não estão funcionando. Ter anúncios de baixo desempenho em sua conta pode reduzir a qualidade de suas campanhas.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Publicidades¶

Consulte os anúncios disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

Você deve especificar o AdGroupId e Type colunas na cláusula WHERE para consultar esta tabela. O conector usa a API do Bing Ads para filtrar os resultados por AdGroup e Type, enquanto o restante do filtro é executado no lado do cliente dentro do conector.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM [Publicidades] WHERE AdGroupId = '5179946006' AND Type = 'Text'
SELECT * FROM Ads WHERE AdGroupId='1297424037031698' AND Type='DynamicSearch' AND AccountId='135093022'
SELECT * from Ads where AdGroupId='1302921473177959' AND Type='Text' AND AccountId in ('2562405', '141163457','180394748')

Você pode desativar a execução do lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a colunas diferentes de AdGroupId e Type causa um erro.

Colunas¶

IdadeGêneroPúblicoRelatório¶

Use este relatório para descobrir como suas campanhas e grupos de anúncios estão repercutindo em públicos de diversas idades e sexos.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatório de Desempenho do Público¶

Use este relatório para comparar estatísticas de desempenho de entrega por público, grupo de anúncios, campanha ou atributos de conta.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Audiências¶

Consulte os públicos disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

As pesquisas nessa tabela são processadas no lado do cliente pelo conector; a consultar a seguir é executada no lado do servidor.

SELECT * FROM [Audiences]
SELECT * FROM Audiences WHERE AccountId='65098547' AND Type='RemarketingList'

A execução da consultar no lado do cliente pode ser desativada definindo SupportEnhancedSQL para falso, caso em que qualquer consultar de pesquisa retornará um erro.

Colunas¶

Oportunidades de Lance¶

Consulte as oportunidades de lance disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

Você deve especificar a coluna OpportunityType na cláusula WHERE para consultar esta tabela. Você pode especificar os seguintes valores para OpportunityType: FirstPage, MainLine e MainLine1.

O conector usará a API do Bing Ads para filtrar os resultados por OpportunityType enquanto o restante do filtro é executado no lado do cliente no conector. Por exemplo, a consultar a seguir é processada no lado do servidor.

SELECT * FROM [Oportunidades de lance] WHERE OpportunityType = 'FirstPage'

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa que se refira a colunas diferentes de OpportunityType causará um erro.

Colunas¶

OrçamentoOportunidades¶

Consulte as oportunidades de orçamento disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

Você deve especificar a coluna CampaignId na cláusula WHERE para consultar esta tabela. O conector usará a API do Bing Ads para filtrar os resultados por CampaignId enquanto o restante do filtro é executado no lado do cliente no conector.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM [OrçamentoOportunidades] WHERE CampaignId = '234505536'

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer critério de pesquisa na cláusula WHERE que se refere a colunas diferentes de CampaignId causará um erro.

Colunas¶

Orçamentos¶

Consulte os orçamentos disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

As pesquisas nessa tabela são processadas no lado do cliente pelo conector; a seguinte consultar é processada do lado do servidor:

SELECT * FROM [Budgets]
SELECT * FROM Budgets WHERE CampaignId='431046229' AND AccountId='65098547'

A execução da consultar no lado do cliente pode ser desativada definindo SupportEnhancedSQL para falso, caso em que qualquer consultar de pesquisa retornará um erro.

Colunas¶

OrçamentoRelatórioResumo¶

Use este relatório para descobrir o desempenho do orçamento de sua campanha para o mês. Por exemplo, o relatório mostra seu orçamento mensal, quanto você gastou até o momento e se está no caminho certo para gastar seu orçamento mensal.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Relatório de Desempenho da Campanha¶

Use este relatório para visualizar estatísticas de desempenho de alto nível e atributos de qualidade para cada campanha ou conta. Essa também é uma maneira rápida de sinalizar qualquer problema importante de campanha ou conta.

Colunas¶

Pseudo-colunas¶

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Campanhas¶

Consulte as Campanhas disponíveis no Bing Ads.

Informações Específicas da Tabela¶

Selecione¶

As pesquisas nessa tabela são processadas no lado do cliente pelo conector; a seguinte consultar é processada do lado do servidor:

SELECT * FROM [Campaigns ]

Você pode desativar a execução da consultar no lado do cliente definindo SupportEnhancedSQL para falso, caso em que qualquer consultar de pesquisa retornará um erro.

Colunas¶

Relatório de Desempenho de Conversão¶

Use esse relatório para entender quais campanhas e palavras-chave estão levando um público a concluir uma compra ou outra ação de conversão.

Colunas¶