- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- CampaignToForecast
- CriterionBidModifier
- CampaignBiddingStrategy
- ManualCpcBiddingStrategy
- MaximizeClicksBiddingStrategy
- MaximizeConversionsBiddingStrategy
- ForecastAdGroup
- BiddableKeyword
- KeywordForecastMetrics
- Faça um teste
Retorna as métricas (como impressões, cliques, custo total) de uma previsão de palavras-chave de determinada campanha.
Lista de erros gerados: AuthenticationError AuthorizationError CollectionSizeError HeaderError InternalError QuotaError RequestError
Solicitação HTTP
POST https://googleads.googleapis.com/v14/customers/{customerId}:generateKeywordForecastMetrics
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
O ID do cliente. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "forecastPeriod": { object ( |
Campos | |
---|---|
forecastPeriod |
O período da previsão. A data de início precisa estar no futuro, e a data de término precisa estar dentro de um ano a partir de hoje. O fuso horário de referência usado é o da conta do Google Ads que pertence ao cliente. Se não for definido, será usado o período padrão do próximo domingo ao sábado seguinte. |
campaign |
Obrigatório. A campanha usada na previsão. |
currencyCode |
A moeda usada para a conversão da taxa de câmbio. Por padrão, é usada a moeda da conta do cliente. Defina esse campo somente se a moeda for diferente da moeda da conta. Confira a lista de códigos de moeda válidos em https://developers.google.com/google-ads/api/data/codes-formats#currency-codes. |
Corpo da resposta
Mensagem de resposta para [KeywordPlanIdeaService.GenerateKeyword pipelineMetrics].
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"campaignForecastMetrics": {
object ( |
Campos | |
---|---|
campaignForecastMetrics |
Resultados da previsão da campanha. |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/adwords
Para mais informações, consulte a Visão geral do OAuth 2.0.
CampaignToForecast
Uma campanha para fazer uma previsão de campanha por palavras-chave.
Representação JSON |
---|
{ "languageConstants": [ string ], "geoModifiers": [ { object ( |
Campos | |
---|---|
languageConstants[] |
A lista de nomes de recursos dos idiomas a serem segmentados. O nome do recurso tem o formato "languageConstants/{criterionId}". Acesse https://developers.google.com/google-ads/api/data/codes-formats#languages para ver a lista de códigos de critério de idioma. |
geoModifiers[] |
Locais a serem segmentados. Os locais precisam ser exclusivos. |
keywordPlanNetwork |
Obrigatório. Rede usada para segmentação. |
negativeKeywords[] |
A lista de palavras-chave negativas que serão usadas na campanha ao fazer a previsão. |
biddingStrategy |
Obrigatório. A estratégia de lances da campanha. |
adGroups[] |
Os grupos de anúncios na nova campanha a ser prevista. |
conversionRate |
A taxa de conversão esperada (número de conversões dividido pelo número total de cliques), conforme definido pelo usuário. Esse valor é expresso como um valor decimal.Sendo assim, uma taxa de conversão esperada de 2% deve ser inserida como 0,02. Se deixado em branco, uma taxa de conversão estimada será usada. |
CriterionBidModifier
Modificador de lance do critério do local.
Representação JSON |
---|
{ "geoTargetConstant": string, "bidModifier": number } |
Campos | |
---|---|
geoTargetConstant |
O nome do recurso da localização geográfica a ser segmentada. O nome do recurso tem o formato "geoTargetConstants/{criterionId}". |
bidModifier |
O multiplicador associado para o criterionId. Se definido, esse valor não pode ser 0. |
CampaignBiddingStrategy
Estratégias de lances compatíveis para previsões de novas campanhas.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união bidding_strategy . Estratégias de lances: bidding_strategy pode ser apenas de um dos tipos a seguir: |
|
manualCpcBiddingStrategy |
Usar a estratégia de lances manuais de CPC para previsão. |
maximizeClicksBiddingStrategy |
Usar a estratégia de lances "Maximizar cliques" para fazer estimativas. |
maximizeConversionsBiddingStrategy |
Usar a estratégia de lances "Maximizar conversões" para fazer estimativas. |
ManualCpcBiddingStrategy
Estratégia de lances manuais de CPC.
Representação JSON |
---|
{ "maxCpcBidMicros": string, "dailyBudgetMicros": string } |
Campos | |
---|---|
maxCpcBidMicros |
Obrigatório. Um lance em micros a ser aplicado a grupos de anúncios da campanha para uma estratégia de lances manuais de CPC. |
dailyBudgetMicros |
Orçamento no nível da campanha em micros. Se definido, um valor mínimo será aplicado à moeda local usada na campanha. Se o campo for definido muito baixo, ocorrerá um erro, mostrando o valor mínimo. |
MaximizeClicksBiddingStrategy
Estratégia de lances "Maximizar cliques".
Representação JSON |
---|
{ "dailyTargetSpendMicros": string, "maxCpcBidCeilingMicros": string } |
Campos | |
---|---|
dailyTargetSpendMicros |
Obrigatório. A meta de gastos diários em micros a ser usada para estimativa. Um valor mínimo é aplicado à moeda local usada na campanha. Se o campo for definido muito baixo, ocorrerá um erro, mostrando o valor mínimo. |
maxCpcBidCeilingMicros |
Lances máximos de CPC, em micros. |
MaximizeConversionsBiddingStrategy
a estratégia de lances "Maximizar conversões".
Representação JSON |
---|
{ "dailyTargetSpendMicros": string } |
Campos | |
---|---|
dailyTargetSpendMicros |
Obrigatório. A meta de gastos diários em micros a ser usada para estimativa. Esse valor precisa ser maior do que zero. |
ForecastAdGroup
Um grupo de anúncios que faz parte de uma campanha a ser prevista.
Representação JSON |
---|
{ "biddableKeywords": [ { object ( |
Campos | |
---|---|
biddableKeywords[] |
Obrigatório. É a lista de palavras-chave que recebem lances que serão usadas no grupo de anúncios durante a previsão. Requer pelo menos uma palavra-chave. |
negativeKeywords[] |
Os detalhes da palavra-chave. Você deve especificar o texto da palavra-chave e o tipo de correspondência. |
maxCpcBidMicros |
O CPC máx. a ser usado para o grupo de anúncios ao gerar o tráfego previsto. Esse valor vai substituir o CPC máx. definido na estratégia de lances. Especifique este campo somente para estratégias de lances que utilizam valores máximos de CPC. |
BiddableKeyword
Uma parte da palavra-chave que recebe lances de um grupo de anúncios.
Representação JSON |
---|
{
"keyword": {
object ( |
Campos | |
---|---|
keyword |
Obrigatório. Palavra-chave. Precisa ter texto e tipo de correspondência. |
maxCpcBidMicros |
Um lance de CPC máx. em micros que substitui o lance de CPC máx. no nível do grupo de anúncios na simulação da previsão. Esse valor substituirá o CPC máx. definido na estratégia de lances e no grupo de anúncios. Especifique este campo apenas para estratégias de lances compatíveis com valores de CPC máx. |
KeywordForecastMetrics
Métricas de estimativa da campanha de palavras-chave sem plano.
Representação JSON |
---|
{ "impressions": number, "clickThroughRate": number, "averageCpcMicros": string, "clicks": number, "costMicros": string, "conversions": number, "conversionRate": number, "averageCpaMicros": string } |
Campos | |
---|---|
impressions |
O número total de impressões. |
clickThroughRate |
A taxa média de cliques. Disponível somente se o número de impressões for maior que zero. |
averageCpcMicros |
O CPC médio. Disponível somente se os cliques forem maiores que zero. |
clicks |
O número total de cliques. |
costMicros |
O custo total. |
conversions |
Número estimado de conversões: cliques * conversionRate. |
conversionRate |
Taxa de conversão estimada. |
averageCpaMicros |
Custo médio por aquisição calculado como costMicros / conversões. |