Utilisation de base

L'utilisation de base de la bibliothèque cliente est la suivante :

use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V26\GoogleAdsClientBuilder;

// Generate a refreshable OAuth 2.0 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

// Construct a Google Ads client configured from a properties file and the
// OAuth 2.0 credentials.
$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    // Replace 1234567890 with your login customer ID.
    ->withLoginCustomerId(1234567890)
    ->build();

// Create the CampaignServiceClient.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();

// Make calls to CampaignServiceClient.

Initialisation du client et du service

Pour envoyer des requêtes à l'API Google Ads, commencez par initialiser une instance client, puis utilisez-la pour créer un client de service.

Créer une instance GoogleAdsClient

La classe la plus importante de la bibliothèque PHP de l'API Google Ads est la classe GoogleAdsClient. Elle vous permet de créer des objets clients de service préconfigurés qui peuvent être utilisés pour effectuer des appels d'API. GoogleAdsClient propose plusieurs façons de la configurer et de l'instancier :

  • Utilisez un fichier google_ads_php.ini.
  • Définissez des variables d'environnement.
  • Appelez des méthodes setter sur GoogleAdsClientBuilder.

Pour en savoir plus, consultez le guide de configuration.

Pour configurer un objet GoogleAdsClient avec des paramètres explicites, créez un OAuth2TokenBuilder objet et un objet GoogleAdsClientBuilder, puis appelez les méthodes setter appropriées :

// Generate a refreshable OAuth 2.0 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID_HERE')
    ->withClientSecret('INSERT_CLIENT_SECRET_HERE')
    ->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
    ->build();

// Construct a Google Ads client configured from explicit settings and the
// OAuth 2.0 credentials.
$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    // Replace 1234567890 with your login customer ID.
    ->withLoginCustomerId(1234567890)
    ->build();

Créer un service

GoogleAdsClient fournit une méthode getter pour chaque objet client de service. Par exemple, pour créer une instance de CampaignServiceClient, appelez la $googleAdsClient->getCampaignServiceClient() méthode, comme illustré dans l' exemple précédent.

Gestion des exceptions

Tous les appels d'API ne sont pas réussis. Le serveur peut générer des erreurs si vos appels d'API échouent pour une raison quelconque. Il est important de capturer les erreurs d'API et de les gérer de manière appropriée.

Une instance GoogleAdsException est générée lorsqu'une erreur d'API se produit. Elle contient des informations qui vous aident à comprendre ce qui s'est passé :

use Google\Ads\GoogleAds\Lib\V26\GoogleAdsException;
use Google\ApiCore\ApiException;

try {
    // Make your API call here.
} catch (GoogleAdsException $googleAdsException) {
    printf(
        "Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
        $googleAdsException->getRequestId(),
        PHP_EOL,
        PHP_EOL
    );
    foreach (
        $googleAdsException->getGoogleAdsFailure()->getErrors() as $error
    ) {
        printf(
            "\t%s: %s%s",
            $error->getErrorCode()->getErrorCode(),
            $error->getMessage(),
            PHP_EOL
        );
    }
} catch (ApiException $apiException) {
    printf(
        "ApiException was thrown with message '%s'.%s",
        $apiException->getMessage(),
        PHP_EOL
    );
}