AdGroupBuilder

Contém os métodos usados para definir e adicionar um grupo de anúncios. Para obter informações sobre construtores, consulte Construtores.

Exemplo de utilização:

    // Get a campaign to add the ad group to.
    var iterator = AdsApp.campaigns()
        .withIds(['CAMPAIGN ID GOES HERE'])
        .get();

    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Get the campaign's ad group builder and add an ad group.
        var operation = campaign.newAdGroupBuilder()
            .withName("AD GROUP NAME GOES HERE")
            .withStatus("ENABLED")
            .build();
    
        // See the Builders topic for performance considerations
        // when using the operation object's methods.
        if (!operation.isSuccessful()) {
            for (var error of operation.getErrors()) {
                Logger.log(`${error}\n`);
            }
        }
    }

Metodologia

Nome do método Tipo de Devolução Descrição
Compilação AdGroupOperation Cria o grupo de anúncios e retorna um objeto de operação usado para verificar se o grupo de anúncios foi adicionado com êxito.
withBiddingStrategy(string biddingStrategy) AdGroupBuilder Define a estratégia de lances do grupo de anúncios.
withCpc(double cpc) AdGroupBuilder Define o lance máximo de CPC do grupo de anúncios.
withCpm(double cpm) AdGroupBuilder Define o lance máximo de CPM do grupo de anúncios.
withCpv(double cpv) AdGroupBuilder Define o lance máximo de CPV do grupo de anúncios.
withCustomParameters(Object customParameters) AdGroupBuilder Define os parâmetros personalizados do grupo de anúncios.
withEndDate(cadeia, endDate) AdGroupBuilder Define a data em que os anúncios no grupo de anúncios param de ser veiculados.
withEndDate(Object endDate) AdGroupBuilder Define a data em que os anúncios no grupo de anúncios param de ser veiculados.
withLanguage(linguagem de cadeia) AdGroupBuilder Define o idioma usado por esse grupo de anúncios.
withName(nome da cadeia) AdGroupBuilder Define o nome do grupo de anúncios.
withStartDate(string startDate) AdGroupBuilder Define a data em que os anúncios no grupo de anúncios começam a ser veiculados.
withStartDate(Object startDate) AdGroupBuilder Define a data em que os anúncios no grupo de anúncios começam a ser veiculados.
withStatus(status da cadeia) AdGroupBuilder Define o status do grupo de anúncios.
withTrackingTemplate(string trackingTemplate) AdGroupBuilder Define o modelo de acompanhamento do grupo de anúncios.

Compilação

Cria o grupo de anúncios e retorna um objeto de operação usado para verificar se o grupo de anúncios foi adicionado com êxito.

Devoluções

Tipo Descrição
AdGroupOperation Um objeto de operação usado para verificar se o grupo de anúncios foi adicionado com êxito.

withBiddingStrategy(string biddingStrategy)

Define a estratégia de lances do grupo de anúncios.

Argumentos

Name Tipo Descrição
biddingStrategy cadeia A estratégia de lances a ser aplicada ao grupo de anúncios. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
  • MANUAL_CPC
  • MANUAL_CPM
  • MANUAL_CPV
Para obter informações sobre essas estratégias, consulte Tipos de estratégia de lance.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com a estratégia de lances aplicada.

withCpc(double cpc)

Define o lance de CPC do grupo de anúncios.

Especifica o valor do lance a ser usado quando a palavra-chave corresponde ao termo de pesquisa do usuário e a estratégia de lance do grupo de anúncios é MANUAL_CPC. Este lance é usado se uma entidade de nível inferior, como palavra-chave, não substituí-lo.

Argumentos

Name Tipo Descrição
CPC duplo O lance máximo de CPC do grupo de anúncios. A moeda da conta determina os valores mínimos e máximos de lances. Para obter mais informações, consulte Moedas de lance e orçamento.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o lance de CPC aplicado.

withCpm(double cpm)

Define o lance de CPM do grupo de anúncios.

Especifica o valor do lance a ser usado por 1.000 impressões visualizadas e quando a estratégia de lances do grupo de anúncios é MANUAL_CPM.

Argumentos

Name Tipo Descrição
CPM duplo O lance máximo de CPM do grupo de anúncios. A moeda da conta determina os valores mínimos e máximos de lances. Para obter mais informações, consulte Moedas de lance e orçamento.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o lance de CPM aplicado.

withCpv(double cpv)

Define o lance CPV do grupo de anúncios.

Especifica o valor do lance a ser usado por visualização ou por clique em um anúncio em vídeo e quando a estratégia de lance do grupo de anúncios é MANUAL_CPV.

Argumentos

Name Tipo Descrição
cpv duplo lance máximo de CPV do grupo de anúncios. A moeda da conta determina os valores mínimos e máximos de lances. Para obter mais informações, consulte Moedas de lance e orçamento.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o lance CPV aplicado.

withCustomParameters(Object customParameters)

Define os parâmetros personalizados do grupo de anúncios a serem usados em URLs finais ou modelos de rastreamento.

Os parâmetros personalizados são úteis na partilha de informações dinâmicas em vários URLs. Para obter mais informações sobre seu uso, consulte Parâmetros personalizados.

Argumentos

Name Tipo Descrição
customParameters Objecto Um mapa com até três parâmetros personalizados para aplicar ao grupo de anúncios. Por exemplo, {key1: 'value1', key2: 'value2', key3: 'value3'}, onde chave é o nome do parâmetro personalizado e valor é o valor do parâmetro. O nome pode conter um máximo de 16 carateres de 8 bytes e o valor pode conter um máximo de 200 carateres de 8 bytes.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor do grupo de anúncios com os parâmetros personalizados aplicados.

withEndDate(cadeia, endDate)

Define a data em que os anúncios no grupo de anúncios param de ser veiculados. Chame esse método apenas se quiser que os anúncios do grupo parem de ser veiculados em uma data específica.

Argumentos

Name Tipo Descrição
DataDeFim cadeia A data para parar de veicular anúncios. Especifique a data no formulário, AAAAMMDD.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com a data de fim aplicada.

withEndDate(Object endDate)

Define a data em que os anúncios no grupo de anúncios param de ser veiculados. Chame esse método apenas se quiser que os anúncios do grupo parem de ser veiculados em uma data específica.

Argumentos

Name Tipo Descrição
DataDeFim Objecto A data para parar de veicular anúncios. Especifique a data utilizando um objeto com os seguintes campos:
  • ano
  • mês
  • Dia

Por exemplo: var date = {year: 2018, month: 5, day: 13};

O mês tem uma base, onde 1 é janeiro e 12 é dezembro.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com a data de fim aplicada.

withLanguage(linguagem de cadeia)

Define o idioma utilizado pelos anúncios neste grupo de anúncios.

Por padrão, o grupo de anúncios herda o idioma da campanha pai. Especifique um idioma no nível do grupo de anúncios para substituir o idioma especificado no nível da campanha ou se a campanha não especificar um idioma (o idioma deve ser especificado no nível da campanha e/ou grupo de anúncios).

Argumentos

Name Tipo Descrição
língua cadeia O idioma usado pelos anúncios no grupo de anúncios. Por exemplo, inglês. A cadeia não diferencia maiúsculas de minúsculas. Não utilize um código de idioma de dois carateres. Para obter uma lista dos idiomas suportados, consulte Idiomas do anúncio.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o idioma aplicado.

withName(nome da cadeia)

Define o nome do grupo de anúncios.

Argumentos

Name Tipo Descrição
Designação cadeia O nome do grupo de anúncios. O nome é obrigatório. O nome pode conter no máximo 256 caracteres e deve ser exclusivo entre todos os grupos de anúncios ativos na campanha.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o nome aplicado.

withStartDate(string startDate)

Define a data em que os anúncios no grupo de anúncios começam a ser veiculados. Chame esse método apenas se quiser que os anúncios do grupo comecem a ser veiculados em uma data específica; Caso contrário, os anúncios começam a ser veiculados imediatamente.

Argumentos

Name Tipo Descrição
DataDeFim cadeia A data para começar a veicular anúncios. Especifique a data no formulário, AAAAMMDD.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com a data de início aplicada.

withStartDate(Object startDate)

Define a data em que os anúncios no grupo de anúncios começam a ser veiculados. Chame esse método apenas se quiser que os anúncios do grupo comecem a ser veiculados em uma data específica; Caso contrário, os anúncios começam a ser veiculados imediatamente.

Argumentos

Name Tipo Descrição
DataDeFim Objecto A data para começar a veicular anúncios. Especifique a data utilizando um objeto com os seguintes campos:
  • ano
  • mês
  • Dia

Por exemplo: var date = {year: 2018, month: 5, day: 13};

O mês tem uma base, onde 1 é janeiro e 12 é dezembro.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com a data de início aplicada.

withStatus(status da cadeia)

Define o status do grupo de anúncios.

Argumentos

Name Tipo Descrição
Estado Cadeia O status do grupo de anúncios. Seguem-se os possíveis valores sensíveis às maiúsculas e minúsculas.
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
A predefinição é PAUSED.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o status aplicado.

withTrackingTemplate(string trackingTemplate)

Define o modelo de acompanhamento do grupo de anúncios.

Os modelos de acompanhamento são usados com o FinalUrl da palavra-chave para criar a URL de destino usada pelo anúncio. Para obter mais informações, consulte Que parâmetros de rastreamento ou URL posso usar?

Argumentos

Name Tipo Descrição
trackingTemplate cadeia O modelo de acompanhamento a ser usado com o grupo de anúncios.

Devoluções

Tipo Descrição
AdGroupBuilder Construtor de grupos de anúncios com o modelo de acompanhamento aplicado.

Consulte também

Campaign.newAdGroupBuilder()