Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Contient les méthodes de gestion d’un budget. Pour plus d’informations, voir Budget.
Méthodes
| Nom de la méthode | Type renvoyé | Description |
|---|---|---|
| Campagnes | Sélecteur de campagne | 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 le mode de livraison (type de budget) pour ce budget. |
| getEntityType | string | Récupère le type de cette entité. |
| getId | string | Obtient l’ID qui identifie de manière unique ce budget partagé. |
| getName | string | Récupère le nom de ce budget partagé. |
| getStats | Statistiques | Obtient les données de performances des campagnes qui partagent ce budget. |
| getType | string | Obtient le type de budget. |
| isExplicitlyShared | Booléen | 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 le mode de livraison pour ce budget. |
Campagnes
Obtient un sélecteur utilisé pour filtrer la liste des campagnes qui partagent ce budget.
Appeler 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 |
|---|---|
| Sélecteur de campagne | Un 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 le mode de livraison du budget (type de budget).
Retourne
| Type | Description |
|---|---|
| string | Mode de livraison du budget. Les valeurs possibles sont les suivantes :
|
getEntityType
Récupère le type de cette entité.
Retourne
| Type | Description |
|---|---|
| string | Type de cette entité, qui est Budget. |
getId
Obtient l’ID qui identifie de manière unique ce budget partagé.
Retourne
| Type | Description |
|---|---|
| string | ID qui identifie de manière unique ce budget partagé. Renvoie null si le budget n’est pas un budget partagé. |
getName
Récupère le nom de ce budget partagé.
Renvoie :
| Type | Description |
|---|---|
| string | Nom du budget partagé. Renvoie null si le budget n’est pas un budget partagé. |
getType
Obtient le type de budget.
Renvoie :
| Type | Description |
|---|---|
| string | Type du budget. Voici les types possibles.
|
getStats
Obtient les données de performances des campagnes qui partagent ce budget.
Les données de performances sont disponibles pour les budgets partagés uniquement. 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 |
|---|---|
| Statistiques | Données de performances pour les campagnes qui partagent ce budget. Renvoie 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 se trouver dans le même compte. Le partage d’un budget peut vous aider à l’utiliser pleinement. 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 comme la campagne B fonctionne bien, elle a dépensé tout son budget et aurait pu dépenser plus. Si les campagnes partageaient un budget, la campagne B utilisait automatiquement les 2 $ que la campagne A n’utilisait pas, ce qui augmentait les chances qu’davantage de trafic vous soit envoyé.
Renvoie :
| Type | Description |
|---|---|
| Booléen | est vrai si le budget est destiné à ê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 getBudget l’entité Campagne.
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 le mode de livraison du budget.
Arguments
| Nom | Type | Description |
|---|---|---|
| méthode | string | Mode de livraison du budget. Les valeurs possibles respectant la casse sont les suivantes :
|
Retourne
| Type | Description |
|---|---|
| void | Renvoie la valeur nothing. |