Orçamento
Contém os métodos para gerir um orçamento. Para obter mais informações, veja Orçamento.
Métodos
Nome do Método | Tipo de Devolução | Descrição |
---|---|---|
campanhas | CampaignSelector | Obtém um seletor utilizado para filtrar a lista de campanhas que partilham este orçamento. |
getAmount | duplo | Obtém o montante do orçamento. |
getDeliveryMethod | cadeia | Obtém o método de entrega (tipo de orçamento) para este orçamento. |
getEntityType | cadeia | Obtém o tipo desta entidade. |
getId | cadeia | Obtém o ID que identifica exclusivamente este orçamento partilhado. |
getName | cadeia | Obtém o nome deste orçamento partilhado. |
getStats | Estatísticas | Obtém os dados de desempenho das campanhas que partilham este orçamento. |
getType | cadeia | Obtém o tipo deste orçamento. |
isExplicitlyShared | Booleano | Obtém um valor Booleano que indica se este orçamento é um orçamento partilhado. |
setAmount(valor duplo) | vazio | Define o orçamento para o montante especificado. |
setDeliveryMethod(Método string) | vazio | Define o método de entrega para este orçamento. |
campanhas
Obtém um seletor utilizado para filtrar a lista de campanhas que partilham este orçamento.
Chame este método apenas a partir de um objeto de orçamento obtido com BudgetSelector; não poderá chamá-lo se tiver obtido o orçamento com o método getBudget da campanha.
Devoluções
Tipo | Descrição |
---|---|
CampaignSelector | Um seletor utilizado para filtrar a lista de campanhas que partilham este orçamento. |
getAmount
Obtém o montante do orçamento.
Devoluções
Tipo | Descrição |
---|---|
duplo | O orçamento, na moeda da conta. |
getDeliveryMethod
Obtém o método de entrega do orçamento (tipo de orçamento).
Devoluções
Tipo | Descrição |
---|---|
cadeia | O método de entrega do orçamento. Os valores possíveis são:
|
getEntityType
Obtém o tipo desta entidade.
Devoluções
Tipo | Descrição |
---|---|
cadeia | O tipo desta entidade, que é Orçamento. |
getId
Obtém o ID que identifica exclusivamente este orçamento partilhado.
Devoluções
Tipo | Descrição |
---|---|
cadeia | O ID que identifica exclusivamente este orçamento partilhado. Devolve nulo se o orçamento não for um orçamento partilhado. |
getName
Obtém o nome deste orçamento partilhado.
Devolve:
Tipo | Descrição |
---|---|
cadeia | O nome do orçamento partilhado. Devolve nulo se o orçamento não for um orçamento partilhado. |
getType
Obtém o tipo deste orçamento.
Devolve:
Tipo | Descrição |
---|---|
cadeia | O tipo do orçamento. Seguem-se os tipos possíveis.
|
getStats
Obtém os dados de desempenho das campanhas que partilham este orçamento.
Os dados de desempenho só estão disponíveis para orçamentos partilhados. Para chamar este método, tem de incluir o método forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo) na cadeia do seletor de orçamento.
Devolve:
Tipo | Descrição |
---|---|
Estatísticas | Os dados de desempenho das campanhas que partilham este orçamento. Devolve nulo se o orçamento não for um orçamento partilhado. |
isExplicitlyShared
Obtém um valor Booleano que indica se este orçamento é um orçamento partilhado.
As campanhas e o orçamento que partilham têm de estar na mesma conta. Partilhar um orçamento pode ajudar a utilizar totalmente o orçamento. Por exemplo, se a campanha A tivesse o seu próprio orçamento de 10 dólares e a campanha B tivesse o seu próprio orçamento de 10 dólares, é possível que a campanha A possa gastar apenas 8 dólares do seu orçamento. Mas como a campanha B está a ter um bom desempenho, gastou todo o seu orçamento e poderia ter gasto mais. Se as campanhas partilhassem um orçamento, a campanha B usaria automaticamente os $2 que a campanha A não usou, aumentando a probabilidade de mais tráfego ser enviado à sua maneira.
Devolve:
Tipo | Descrição |
---|---|
Booleano | É verdade se o orçamento se destina a ser partilhado por várias campanhas; caso contrário, falso. |
setAmount(valor duplo)
Define o montante do orçamento.
Para atualizar um orçamento partilhado, tem de obter o orçamento com BudgetSelector e BudgetIterator. A definição do montante do orçamento falha se receber o orçamento com o método da getBudget
entidade Campanha.
Argumentos
Name | Tipo | Descrição |
---|---|---|
montante | duplo | O orçamento, na moeda da conta. |
Devoluções
Tipo | Descrição |
---|---|
vazio | Não devolve nada. |
setDeliveryMethod(método de cadeia)
Define o método de entrega do orçamento.
Argumentos
Name | Tipo | Descrição |
---|---|---|
método | cadeia | O método de entrega do orçamento. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
|
Devoluções
Tipo | Descrição |
---|---|
vazio | Não devolve nada. |