La bibliothèque cliente PHP facilite les interactions avec l'API Google Ads avec une configuration minimale de votre part. Toutefois, les performances dépendent fortement de la manière dont la bibliothèque est utilisée et intégrée.
La plupart de ces bonnes pratiques s'appliquent à tous les langages. Ce guide présente celles qui sont spécifiques à PHP.
Implémentation de Protobuf
Protobuf est utilisé par gRPC et l'API Google Ads pour les messages de requête et de réponse. Deux implémentations sont disponibles, mais celle écrite en C offre de meilleures performances.
Pour en savoir plus, consultez le guide Protobuf.
Mode de fonctionnement de l'interpréteur PHP
PHP est un langage de script polyvalent qui dispose de nombreux modes de fonctionnement en fonction de son utilisation. PHP CGI (Common Gateway Interface) présente un avantage notable, car il peut partager des ressources entre les exécutions.
Version de PHP
Il est recommandé de passer régulièrement à une version plus récente de PHP, car elle offre généralement de meilleures performances globales. Liste des versions de PHP compatibles.
Versions de l'API Google Ads non utilisées
Toutes les versions de la bibliothèque cliente sont compatibles avec plusieurs versions de l'API Google Ads. Pour chaque version de l'API Google Ads compatible avec la bibliothèque cliente, il existe des packages dédiés à cette version.
Les packages dédiés aux versions de l'API Google Ads qui ne sont pas utilisées peuvent être supprimés de la bibliothèque cliente en toute sécurité. Comme il peut être utile d'accélérer l'exécution ou de réduire l'espace mémoire utilisé, la bibliothèque cliente fournit des utilitaires pour le faire par programmation.
Exemple
Supposons que vous implémentiez la bibliothèque cliente qui n'utilise que la dernière version de l'API : v25, et que vous souhaitiez supprimer la compatibilité avec les versions de l'API non utilisées : v24 et v23.
Dans le fichier composer.json du projet, définissez un script Composer (nommé
remove-google-ads-api-version-support) qui exploite l'utilitaire fourni par
la bibliothèque cliente, dans la classe
ApiVersionSupport :
"scripts": {
"remove-google-ads-api-version-support": [
"Google\\Ads\\GoogleAds\\Util\\ApiVersionSupport::remove"
]
}
Ensuite, utilisez le script Composer avec les numéros de version comme paramètres et affichez des messages d'état :
# Change the current directory to the project directory.
cd /path/to/the/project
# Install the project.
composer install
# Output the vendor folder size and the list of Google Ads API versions that are
# supported before removing support for Google Ads API versions.
echo "# Supported Google Ads API versions:"
find ./vendor/googleads/google-ads-php/src/Google/Ads/GoogleAds/V* -maxdepth 0 | grep -o '..$'
echo "# Vendor folder size:"
du -sh ./vendor
# Use the Composer script to remove the unused versions v23 and v24 of the Google Ads API.
echo "# Removing support..."
composer run-script remove-google-ads-api-version-support -- 23 24
# Output the vendor folder size and the list of Google Ads API versions that are
# supported after removing support for Google Ads API versions.
echo "# Supported Google Ads API versions:"
find ./vendor/googleads/google-ads-php/src/Google/Ads/GoogleAds/V* -maxdepth 0 | grep -o '..$'
echo "# Vendor folder size:"
du -sh ./vendor
L'exemple de sortie d'exécution ci-dessous indique une réduction de la taille du fichier de 50 Mo et la seule version compatible restante est V25 :
# Supported Google Ads API versions:
V23
V24
V25
# Vendor folder size:
110M ./vendor
# Removing support...
> Google\Ads\GoogleAds\Util\ApiVersionSupport::remove
Removing support for the version 23 of Google Ads API...
Done
Removing support for the version 24 of Google Ads API...
Done
# Supported Google Ads API versions:
V25
# Vendor folder size:
60M ./vendor
Développement et production
PHP est un langage interprété qui compile d'abord les instructions avant de les exécuter. Cela est généralement avantageux, car pendant le développement, les sources changent souvent, tandis que le temps d'exécution n'est pas aussi crucial. Toutefois, l'inverse est vrai au moment de la production, car la stabilité et les performances deviennent les principales préoccupations.
Cache
La mise en cache est courante et fortement recommandée, car elle améliore les performances et la stabilité en stockant les instructions de script précompilées.
OPcache est la solution la plus couramment utilisée et est disponible par défaut.
Réapprovisionnement automatique
Le réapprovisionnement automatique est courant car il améliore les performances et la stabilité en chargeant des informations précompilées sur les classes.
La bibliothèque cliente PHP est conforme à PSR-4 pour
le réapprovisionnement automatique et fournit la définition dans le
composer.json
fichier. Des options dédiées de Composer, telles que
--optimize-autoloader ou --classmap-authoritative, peuvent ensuite être
utilisées immédiatement.
Journalisation
Définir des enregistreurs de journaux sur un niveau élevé, tel que ERROR, peut aider à réduire la surcharge du temps d'exécution et la consommation de mémoire.
Pour en savoir plus, consultez le guide de Logging.
Débogage et profilage
Nous vous recommandons de désactiver les outils de débogage et de profilage, car ils entraînent généralement une surcharge du temps d'exécution.
Précharger
Depuis PHP 7.4, OPcache preloading peut être utilisé pour précharger des scripts en mémoire, ce qui va plus loin que la mise en cache classique.
Un script doit être conçu pour tirer parti de cette fonctionnalité, mais la bibliothèque cliente PHP ne le fait pas, car il n'existe aucun moyen générique d'implémenter le préchargement OPcache, et le compromis entre l'utilisation de la mémoire et le gain de performances est très spécifique à un projet et à une exécution donnés.