BingAdsAccountSelector
Contient les méthodes de filtrage et de classement de la liste des comptes auxquels l’utilisateur a accès. Pour plus d’informations sur les sélecteurs, consultez Sélecteurs.
Exemple d’utilisation :
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
Méthodes
| Nom de la méthode | Type renvoyé | Description |
|---|---|---|
| executeInParallel(string functionName, string optionalCallbackFunctionName) | void | Exécute la fonction pour chaque compte retourné par le sélecteur. |
| executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput) | void | Exécute la fonction pour chaque compte retourné par le sélecteur. |
| forDateRange(Object dateFrom, Object dateTo) | BingAdsAccountSelector | Applique les dates de début et de fin pour la sélection des métriques de performances. |
| forDateRange(string dateRange) | BingAdsAccountSelector | Applique la plage de dates prédéfinie pour la sélection des métriques de performances. |
| get | BingAdsAccountIterator | Obtient un itérateur utilisé pour itérer dans la liste des comptes. |
| orderBy(string orderBy) | BingAdsAccountSelector | Applique le classement spécifié aux comptes sélectionnés. |
| withAccountNumbers(string[] accountNumbers) | BingAdsAccountSelector | Obtient les comptes avec les numéros de compte spécifiés. |
| withCondition(string condition) | BingAdsAccountSelector | Applique des critères de filtre aux comptes. |
| withIds(string[] ids) | BingAdsAccountSelector | Obtient les comptes avec les ID spécifiés. |
| withLimit(int limit) | BingAdsAccountSelector | Obtient les n premiers comptes qui correspondent aux critères de sélection. |
executeInParallel(string functionName, string optionalCallbackFunctionName)
Exécute la fonction pour chaque compte retourné par le sélecteur. Une fois la fonction exécutée pour tous les comptes sélectionnés, Scripts appelle la fonction de rappel facultative.
Remarque
Le script peut exécuter un maximum de 50 comptes en parallèle à chaque exécution du script. Vous pouvez appeler cette méthode une ou plusieurs fois, mais le nombre total de comptes que tous les appels traitent ne doit pas dépasser 50. Si un appel dépasse le maximum de 50 comptes pour le script, aucun des comptes de l’appel n’est exécuté. Pour limiter le nombre de comptes retournés par le sélecteur, envisagez d’utiliser la withLimit méthode ou withIds .
La fonction functionName peut retourner une valeur sous forme de chaîne. Pour renvoyer un objet complexe, utilisez la méthode JSON.stringify pour convertir l’objet en chaîne. Vous pouvez ensuite utiliser la méthode JSON.parse pour reconverti la chaîne en objet . Si votre fonction retourne une valeur, vous devez spécifier une fonction de rappel pour capturer les valeurs de retour. L’exemple suivant montre la signature de la fonction de rappel. Les valeurs retournées sont passées sous la forme d’un tableau d’objets ExecutionResult .
function myCallback(ExecutionResult[] results)
L’exemple suivant montre comment traiter les valeurs retournées dans la fonction de rappel.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Étant donné que cette méthode ne retourne pas d’objet BingAdsAccountSelector , assurez-vous que cette méthode est la dernière méthode de sélecteur dans la chaîne d’appels.
Pour obtenir un exemple, consultez Découverte d’annonces désapprouvées.
Arguments
| Nom | Type | Description |
|---|---|---|
| Functionname | string | Nom de la fonction à exécuter pour chaque compte retourné par le sélecteur. La méthode currentAccount identifie le compte que la fonction traite. |
| optionalCallbackFunctionName | string | Facultatif. Nom de la fonction à exécuter une fois que tous les comptes ont terminé l’exécution de la fonction functionName . Cette fonction ne s’exécute qu’une seule fois. |
Retourne
| Type | Description |
|---|---|
| void | Renvoie la valeur nothing. |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)
Exécute la fonction pour chaque compte retourné par le sélecteur. Une fois la fonction exécutée pour tous les comptes sélectionnés, Scripts appelle la fonction de rappel facultative.
Remarque
Le script peut exécuter un maximum de 50 comptes en parallèle à chaque exécution du script. Vous pouvez appeler cette méthode une ou plusieurs fois, mais le nombre total de comptes que tous les appels traitent ne doit pas dépasser 50. Si un appel dépasse le maximum de 50 comptes pour le script, aucun des comptes de l’appel n’est exécuté. Pour limiter le nombre de comptes retournés par le sélecteur, envisagez d’utiliser la withLimit méthode ou withIds .
La fonction functionName peut retourner une valeur sous forme de chaîne. Pour renvoyer un objet complexe, utilisez la méthode JSON.stringify pour convertir l’objet en chaîne. Vous pouvez ensuite utiliser la méthode JSON.parse pour reconverti la chaîne en objet . Si votre fonction retourne une valeur, vous devez spécifier une fonction de rappel pour capturer les valeurs de retour. L’exemple suivant montre la signature de la fonction de rappel. Les valeurs retournées sont passées sous la forme d’un tableau d’objets ExecutionResult .
function myCallback(ExecutionResult[] results)
L’exemple suivant montre comment traiter les valeurs retournées dans la fonction de rappel.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Si vous passez le paramètre d’entrée facultatif, le code suivant montre la signature de la fonction functionName .
function myFunction(string optionalInput)
Étant donné que cette méthode ne retourne pas d’objet BingAdsAccountSelector , assurez-vous que cette méthode est la dernière méthode de sélecteur dans la chaîne d’appels.
Pour obtenir un exemple, consultez Découverte d’annonces désapprouvées.
Arguments
| Nom | Type | Description |
|---|---|---|
| Functionname | string | Nom de la fonction à exécuter pour chaque compte retourné par le sélecteur. La méthode currentAccount identifie le compte que la fonction traite. |
| optionalCallbackFunctionName | string | Facultatif. Nom de la fonction à exécuter une fois que tous les comptes ont terminé l’exécution de la fonction functionName . Cette fonction ne s’exécute qu’une seule fois. |
| optionalInput | string | Facultatif. Entrée à passer à la fonction functionName . |
Retourne
| Type | Description |
|---|---|
| void | Renvoie la valeur nothing. |
forDateRange(Object dateFrom, Object dateTo)
Applique les dates de début et de fin pour la sélection des métriques de performances.
Spécifiez une plage de dates uniquement si :
- Vous appliquez des conditions ou un ordre qui référence des champs de métrique de performances.
- Vous souhaitez obtenir des données de performances pour les objets que vous sélectionnez. Par exemple, si vous envisagez d’appeler la
getStats()méthode .
Vous pouvez spécifier les paramètres de date à l’aide de chaînes ou d’objets. Pour utiliser des chaînes, spécifiez la date au format AAAAMMJJ. Si vous utilisez des objets, créez un objet avec les champs suivants :
- year
- month
- Jour
Par exemple :
var date = {year: 2018, month: 5, day: 13};
Le mois est basé sur un, où 1 est janvier et 12 décembre.
La plage de dates est inclusive. Si vous spécifiez plusieurs plages de dates, seule la dernière plage de dates est utilisée.
Arguments
| Nom | Type | Description |
|---|---|---|
| dateFrom | Objet | Date de début de la plage de dates qui spécifie les données de performances à inclure dans le sélecteur. |
| dateTo | Objet | Date de fin de la plage de dates qui spécifie les données de performances à inclure dans le sélecteur. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec plage de dates appliquée. |
forDateRange(String dateRange)
Applique la plage de dates prédéfinie pour la sélection des métriques de performances.
Valeurs de plage de dates prises en charge :
- AUJOURD'HUI
- HIER
- LAST_WEEK
- LAST_BUSINESS_WEEK
- LAST_7_DAYS
- THIS_WEEK_SUN_TODAY
- LAST_14_DAYS
- LAST_30_DAYS
- LAST_WEEK_SUN_SAT
- THIS_MONTH
- LAST_MONTH
- ALL_TIME
Spécifiez une plage de dates uniquement si :
- Vous appliquez des conditions ou un ordre qui référence des champs de métrique de performances.
- Vous souhaitez obtenir des données de performances pour les objets que vous sélectionnez. Par exemple, si vous envisagez d’appeler la
getStats()méthode .
Si vous spécifiez plusieurs plages de dates, seule la dernière plage de dates est utilisée.
Arguments
| Nom | Type | Description |
|---|---|---|
| dateRange | Chaîne | Chaîne de plage de dates prédéfinie qui spécifie les données de performances à inclure dans le sélecteur. La chaîne de plage de dates prédéfinie respecte la casse. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec plage de dates appliquée. |
Avoir
Obtient un itérateur utilisé pour itérer dans la liste des comptes.
Retourne
| Type | Description |
|---|---|
| BingAdsAccount | Itérateur utilisé pour itérer dans les comptes sélectionnés. |
orderBy(string orderBy)
Applique le classement spécifié aux comptes sélectionnés.
Spécifiez le paramètre orderBy sous la forme « columnName orderDirection » où :
- columnName est l’une des colonnes prises en charge.
- orderDirection est l’ordre dans lequel trier les résultats. Définissez sur ASC pour classer les résultats dans l’ordre croissant ou sur DESC pour classer les résultats dans l’ordre décroissant. La valeur par défaut est ASC.
Par exemple, l’appel suivant retourne les résultats dans l’ordre croissant par clics.
selector = selector.orderBy("Clicks");
Les sélecteurs prennent en charge le classement des entités par un seul champ. Vous ne pouvez pas classer la liste des entités par champ x, et dans x par champ y, et ainsi de suite. Si vous spécifiez plusieurs orderBy() appels dans une chaîne ou dans des appels de sélecteur distincts, les scripts commandent la liste des entités à l’aide du champ spécifié dans le dernier orderBy() appel.
Arguments
| Nom | Type | Description |
|---|---|---|
| Orderby | string | Ordre à appliquer. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec classement appliqué. |
withAccountNumbers(string[] accountNumbers)
Obtient les comptes avec les numéros de compte spécifiés.
Arguments
| Nom | Type | Description |
|---|---|---|
| accountNumbers | string[] | Tableau de numéros de compte. Pour connaître les limites, consultez Limites d’exécution de script. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec les numéros de compte appliqués. |
withCondition(String condition)
Applique des critères de filtre aux comptes.
Spécifiez le paramètre de condition sous la forme « columnName operator value » où :
- columnName est l’une des colonnes prises en charge. Si columName est défini sur un nom de colonne de métrique de performance, vous devez spécifier une plage de dates à l’aide de forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo).
- est l’un des opérateurs pris en charge.
Opérateurs
L’opérateur que vous utilisez dépend du type de la colonne. Les opérateurs respectent la casse. Par exemple, utilisez STARTS_WITH au lieu de starts_with.
Opérateurs pour les colonnes qui contiennent des entiers et des valeurs longues :
<
<=
>
>=
=
!=
Opérateurs pour les colonnes qui contiennent des valeurs doubles :
<
>
Opérateurs pour les colonnes qui contiennent des valeurs de chaîne :
=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE
Opérateurs pour les colonnes qui contiennent des valeurs d’énumération :
=
!=
IN []
NOT_IN []
Opérateurs pour les colonnes qui contiennent un tableau de chaînes :
CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE
Colonnes prises en charge pour le filtrage de compte. Les noms des colonnes sont sensibles à la casse.
Voici les colonnes de métriques de performances que vous pouvez spécifier.
| Column | Type | Exemple | Filtre de l’interface utilisateur web Microsoft Advertising |
|---|---|---|---|
| ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
Taux conv. |
| Clics | long | withCondition("Clicks >= 33") |
Clics |
| ConvertedClicks | long | withCondition("ConvertedClicks >= 10") |
Conv. |
| Coût | double | withCondition("Cost > 3.25")Le coût est dans la devise du compte. |
Passer |
| Ctr | double | withCondition("Ctr > 0.05")Le CTR étant dans la plage 0..1, utilisez 0,05 pour un CTR de 5 %. |
CTR |
| Impressions | long | withCondition("Impressions > 10") |
Impr. |
Voici les propriétés de compte que vous pouvez spécifier.
| Column | Type | Exemple | Filtre de l’interface utilisateur web Microsoft Advertising |
|---|---|---|---|
| CurrencyCode | string | Code monétaire de la devise utilisée par le compte. Par exemple, usd pour États-Unis dollar.withCondition("CurrencyCode = USD") |
|
| ManagerCustomerId | chaîne | ID client de l’utilisateur qui gère les comptes.withCondition("ManagerCustomerId = '123456789'") |
|
| Nom | string | Nom d’un compte géré.withCondition("Name CONTAINS_IGNORE_CASE 'foo'") |
Arguments
| Nom | Type | Description |
|---|---|---|
| Condition | string | Condition à ajouter au sélecteur. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec la condition appliquée. |
withIds(string[] ids)
Obtient les comptes avec les ID spécifiés.
Vous pouvez appliquer une ou plusieurs conditions à un sélecteur. Une chaîne de conditions est considérée comme une opération AND. Par exemple, l’entité est sélectionnée uniquement si la condition A a la valeur true ET si la condition B a la valeur true. Par exemple, l’appel suivant sélectionne uniquement le compte 33333.
AccountsApp.accounts()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
.get();
Arguments
| Nom | Type | Description |
|---|---|---|
| Ids | string[] | Tableau d’ID de compte. Pour connaître les limites, consultez Limites d’exécution de script. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec les ID appliqués. |
withLimit(int limit)
Obtient les n premiers comptes qui correspondent aux critères de sélection.
Arguments
| Nom | Type | Description |
|---|---|---|
| limit | int | Nombre de comptes à retourner. Le nombre réel peut être inférieur. |
Retourne
| Type | Description |
|---|---|
| BingAdsAccountSelector | Sélecteur avec limite appliquée. |