Estrutura da consulta

As consultas de campos de recursos, segmentos e métricas podem ser enviadas aos métodos GoogleAdsService Search ou SearchStream. Para criar uma consulta na linguagem de consulta do Google Ads, você precisa usar a gramática da linguagem. Uma consulta é composta por várias cláusulas:

• SELECT
• FROM
• WHERE
• ORDER BY
• LIMIT
• PARAMETERS

As cláusulas usam nomes de campo, nomes de recurso, operadores, condições e ordenações para ajudar você a selecionar os dados corretos. Depois de combinadas em uma única consulta, uma solicitação pode ser feita usando a API Google Ads.

Cláusulas

ondemand_video Vídeo: Compatibilidade de campos do GAQL

SELECT

A cláusula SELECT especifica um conjunto de campos a serem buscados na solicitação. SELECT recebe uma lista de campos de recursos, campos de segmentos e métricas separados por vírgulas, retornando os valores na resposta. A cláusula SELECT é obrigatória em uma consulta.

A consulta de exemplo abaixo mostra como selecionar atributos para um determinado recurso:

SELECT
  campaign.id,
  campaign.name
FROM campaign

É possível solicitar diferentes tipos de campo em uma única solicitação, como:

SELECT
  campaign.id,
  campaign.name,
  bidding_strategy.id,
  bidding_strategy.name,
  segments.device,
  segments.date,
  metrics.impressions,
  metrics.clicks
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

• Campos de recursos

  • campaign.id
  • campaign.name

• Campos de recursos

  • bidding_strategy.id
  • bidding_strategy.name

• Campos de segmentos

  • segments.device
  • segments.date

• Métricas

  • metrics.impressions
  • metrics.clicks

Alguns campos podem não ser permitidos na cláusula SELECT devido às seguintes restrições:

• Consultar campos que não são selecionáveis. O atributo de metadados Selectable desses campos será marcado como false.
• Selecionando atributos de campos repetidos. O atributo de metadados isRepeated desses campos será marcado como true.
• Selecionar campos que não estão disponíveis para o recurso especificado na cláusula FROM. Os atributos de alguns recursos não podem ser selecionados juntos. Além disso, apenas um subconjunto de todas as métricas e segmentos estará disponível para o recurso na cláusula FROM.
• Selecionar segmentos ou métricas que não são compatíveis entre si. Para mais informações, consulte a seção Segmentação.

As informações relacionadas às condições acima podem ser encontradas nos nossos documentos de referência ou em GoogleAdsFieldService.

FROM

A cláusula FROM especifica o recurso principal que será retornado. O recurso na cláusula FROM define quais campos podem ser usados em todas as outras cláusulas para a consulta. Apenas um recurso pode ser especificado na cláusula FROM. A cláusula FROM é necessária em uma consulta para os métodos GoogleAdsService Search ou SearchStream. No entanto, ela não precisa ser especificada ao usar o GoogleAdsFieldService.

Embora apenas um recurso possa existir na cláusula FROM para uma determinada consulta, os campos dos recursos atribuídos também podem estar disponíveis. Esses recursos são implicitamente unidos ao recurso na cláusula FROM. Portanto, basta adicionar os atributos deles à cláusula SELECT para retornar os valores. Nem todos os recursos têm recursos atribuídos. No exemplo a seguir, é possível solicitar o ID do grupo de anúncios e o ID da campanha dos grupos de anúncios:

SELECT
  campaign.id,
  ad_group.id
FROM ad_group

O campo resource_name do recurso principal é sempre retornado. No exemplo abaixo, ad_group.resource_name será incluído na resposta, mesmo sem ser selecionado explicitamente na consulta:

SELECT ad_group.id
FROM ad_group

O mesmo acontece com outros recursos quando pelo menos um campo é selecionado. Por exemplo, campaign.resource_name será incluído na resposta para a consulta a seguir:

SELECT
  campaign.id,
  ad_group.id
FROM ad_group

WHERE

A cláusula WHERE especifica as condições a serem aplicadas ao filtrar dados para a solicitação. Ao usar a cláusula WHERE, é possível especificar uma ou mais condições usando AND para separá-las. Cada condição precisa seguir o padrão field_name Operator value. A cláusula WHERE é opcional em uma consulta.

Confira a seguir um exemplo de como usar WHERE para retornar métricas de um determinado período de tempo:

SELECT
  campaign.id,
  campaign.name,
  metrics.impressions
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

É possível combinar várias condições para filtrar os dados. Este exemplo vai solicitar o número de cliques de todas as campanhas com impressões em dispositivos móveis nos últimos 30 dias.

SELECT
  campaign.id,
  campaign.name,
  segments.device,
  metrics.clicks
FROM campaign
WHERE metrics.impressions > 0
  AND segments.device = MOBILE
  AND segments.date DURING LAST_30_DAYS

Os segmentos na cláusula WHERE precisam estar na cláusula SELECT, com os seguintes segmentos de data, chamados de segmentos de data principais, sendo exceções:

• segments.date
• segments.week
• segments.month
• segments.quarter
• segments.year

Na consulta a seguir, segments.date está selecionado. Como esse segmento é um segmento de data principal, ele exige um período finito composto de segmentos de data principais na cláusula WHERE.

SELECT
  campaign.id,
  campaign.name,
  segments.date,
  metrics.clicks
FROM campaign
WHERE segments.date DURING LAST_30_DAYS

Todos os segmentos que atendem à condição acima são: segments.date, segments.week, segments.month, segments.quarter e segments.year. Se algum desses segmentos for selecionado, pelo menos um deles precisará ser usado na cláusula WHERE.

Ao filtrar, é importante considerar a diferenciação entre maiúsculas e minúsculas do operador. Consulte Diferença entre maiúsculas e minúsculas para mais detalhes.

Para conferir uma lista completa de operadores, consulte a gramática de linguagem.

ORDER BY

A cláusula ORDER BY especifica a ordem em que os resultados serão retornados. Isso permite organizar os dados em ordem crescente ou decrescente com base no nome de um campo. Cada ordenação é especificada como field_name seguida por ASC ou DESC. Se nem ASC nem DESC forem especificados, a ordem padrão será ASC. A cláusula ORDER BY é opcional em uma consulta.

A consulta a seguir ordena as campanhas retornadas por número de cliques, da mais alta para a mais baixa:

SELECT
  campaign.name,
  metrics.clicks
FROM campaign
ORDER BY metrics.clicks DESC

É possível especificar vários campos na cláusula ORDER BY usando uma lista separada por vírgulas. A ordenação vai ocorrer na mesma sequência especificada na consulta. Por exemplo, nesta consulta que seleciona dados de grupos de anúncios, os resultados são classificados em ordem crescente pelo nome da campanha, depois em ordem decrescente pelo número de impressões e, por fim, em ordem decrescente pelo número de cliques:

SELECT
  campaign.name,
  ad_group.name,
  metrics.impressions,
  metrics.clicks
FROM ad_group
ORDER BY
  campaign.name,
  metrics.impressions DESC,
  metrics.clicks DESC

LIMIT

A cláusula LIMIT permite especificar o número de resultados que serão retornados. Isso é útil se você só quer um resumo.

Por exemplo, LIMIT pode ser usado para restringir o número total de resultados da seguinte consulta:

SELECT
  campaign.name,
  ad_group.name,
  segments.device,
  metrics.impressions
FROM ad_group
ORDER BY metrics.impressions DESC
LIMIT 50

PARÂMETROS

A cláusula PARAMETERS permite especificar metaparâmetros para a solicitação. Esses parâmetros podem afetar os tipos de linhas retornadas.

No momento, os seguintes metaparâmetros são compatíveis:

include_drafts

Defina include_drafts como true para permitir que as entidades de rascunho sejam retornadas. O valor padrão é false.

Por exemplo, a consulta a seguir busca campanhas de rascunho e campanhas normais:

SELECT campaign.name
FROM campaign
PARAMETERS include_drafts=true

omit_unselected_resource_names

Defina omit_unselected_resource_names como true para evitar que o nome do recurso de cada tipo de recurso na resposta seja retornado, a menos que seja solicitado explicitamente na cláusula SELECT. O padrão é false.

SELECT
  campaign.name,
  customer.id
FROM campaign

SELECT
  campaign.name,
  customer.id
FROM campaign
PARAMETERS omit_unselected_resource_names = true

SELECT
  campaign.name,
  campaign.resource_name
FROM campaign
PARAMETERS omit_unselected_resource_names = true

Outras regras de idioma

Além dos exemplos de cada cláusula, a linguagem de consulta do Google Ads tem os seguintes comportamentos que podem ser usados:

• Não é necessário que o campo de recurso principal esteja na cláusula SELECT de uma consulta. Por exemplo, talvez você queira usar apenas um ou mais campos de recursos principais para filtrar dados:

  SELECT campaign.id
  FROM ad_group
  WHERE ad_group.status = PAUSED
  

• As métricas podem ser selecionadas exclusivamente para um determinado recurso. Nenhum outro campo do recurso é necessário na consulta:

  SELECT
    metrics.impressions,
    metrics.clicks,
    metrics.cost_micros
  FROM campaign
  

• Os campos de segmentação podem ser selecionados sem campos de recurso ou métricas:

  SELECT segments.device FROM campaign
  

• O campo resource_name (campaign.resource_name, por exemplo) pode ser usado para filtrar ou ordenar dados:

  SELECT
    campaign.id,
    campaign.name
  FROM campaign
  WHERE campaign.resource_name = 'customers/1234567/campaigns/987654'