Partager via

Budget

  • Article

Contient les méthodes de gestion d’un budget. Pour plus d’informations, consultez Budget.

Méthodes

Nom de la méthode Type renvoyé Description
Campagnes CampaignSelector Obtient un sélecteur utilisé pour filtrer la liste des campagnes qui partagent ce budget.
getAmount double Obtient le montant du budget.
getDeliveryMethod string Obtient la méthode de livraison (type de budget) pour ce budget.
getEntityType string Obtient le type de cette entité.
getId string Obtient l’ID qui identifie de façon unique ce budget partagé.
Getname string Obtient le nom de ce budget partagé.
getStats Stats Obtient les données de performances pour les campagnes qui partagent ce budget.
Gettype string Obtient le type de ce budget.
isExplicitlyShared Valeur booléenne Obtient une valeur booléenne qui indique si ce budget est un budget partagé.
setAmount(double amount) void Définit le budget sur le montant spécifié.
setDeliveryMethod(String, méthode) void Définit la méthode de remise pour ce budget.

Campagnes

Obtient un sélecteur utilisé pour filtrer la liste des campagnes qui partagent ce budget.

Appelez cette méthode uniquement à partir d’un objet de budget récupéré à l’aide de BudgetSelector ; vous ne pouvez pas l’appeler si vous avez récupéré le budget à l’aide de la méthode getBudget de la campagne.

Retourne

Type Description
CampaignSelector Sélecteur utilisé pour filtrer la liste des campagnes qui partagent ce budget.

getAmount

Obtient le montant du budget.

Retourne

Type Description
double Budget, dans la devise du compte.

getDeliveryMethod

Obtient la méthode de remise du budget (type de budget).

Retourne

Type Description
string Méthode de livraison du budget. Les valeurs possibles sont les suivantes :
  • STANDARD
  • ACCÉLÉRÉ
Pour plus d’informations, consultez Quelles sont mes options budgétaires ?

getEntityType

Obtient le type de cette entité.

Retourne

Type Description
string Le type de cette entité, qui est Budget.

getId

Obtient l’ID qui identifie de façon unique ce budget partagé.

Retourne

Type Description
string ID qui identifie de façon unique ce budget partagé. Retourne null si le budget n’est pas un budget partagé.

Getname

Obtient le nom de ce budget partagé.

Renvoie :

Type Description
string Nom du budget partagé. Retourne null si le budget n’est pas un budget partagé.

Gettype

Obtient le type de ce budget.

Renvoie :

Type Description
string Type de budget. Voici les types possibles.
  • QUOTIDIENNE

getStats

Obtient les données de performances pour les campagnes qui partagent ce budget.

Les données de performances sont disponibles uniquement pour les budgets partagés. Pour appeler cette méthode, vous devez inclure la méthode forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo) dans la chaîne du sélecteur de budget.

Renvoie :

Type Description
Stats Données de performances pour les campagnes qui partagent ce budget. Retourne null si le budget n’est pas un budget partagé.

isExplicitlyShared

Obtient une valeur booléenne qui indique si ce budget est un budget partagé.

Les campagnes et le budget qu’elles partagent doivent être dans le même compte. Le partage d’un budget peut aider à utiliser pleinement le budget. Par exemple, si la campagne A avait son propre budget de 10 $ et que la campagne B avait son propre budget de 10 $, il est possible que la campagne A ne dépense que 8 $ de son budget. Mais parce que la campagne B fonctionne bien, elle a dépensé tout son budget et aurait pu dépenser plus. Si les campagnes partagent un budget, la campagne B utilise automatiquement les 2 $ que la campagne A n’a pas utilisées, ce qui augmente le risque que davantage de trafic soit envoyé à votre chemin.

Renvoie :

Type Description
Boolean Est vrai si le budget est censé être partagé par plusieurs campagnes ; sinon, false.

setAmount(double amount)

Définit le montant du budget.

Pour mettre à jour un budget partagé, vous devez obtenir le budget à l’aide de BudgetSelector et BudgetIterator. La définition du montant du budget échoue si vous obtenez le budget à l’aide de la méthode de l’entité getBudgetCampaign.

Arguments

Nom Type Description
Montant double Budget, dans la devise du compte.

Retourne

Type Description
void Renvoie la valeur nothing.

setDeliveryMethod(string, méthode)

Définit la méthode de remise du budget.

Arguments

Nom Type Description
méthode string Méthode de livraison du budget. Les valeurs possibles respectant la casse sont les suivantes :
  • STANDARD
  • ACCÉLÉRÉ
Pour plus d’informations, consultez Quelles sont mes options budgétaires ?

Retourne

Type Description
void Renvoie la valeur nothing.

Voir aussi

Campaign.getBudget()BudgetIterator.next()