Métadonnées de réponse

Par défaut, la bibliothèque cliente PHP journalise les métadonnées de réponse, y compris un ID de requête. Vous pouvez également obtenir les métadonnées de réponse de manière programmatique lorsque vous appelez des méthodes de service client en définissant le paramètre facultatif withResponseMetadata sur true.

Après avoir appelé les méthodes de service client, vous pouvez obtenir GoogleAdsResponseMetadata à partir d'un objet pertinent, tel qu'un client de service ou un flux, en fonction de la méthode que vous appelez. Cet objet contient getMetadata() et getRequestId(), qui renvoient respectivement les métadonnées de réponse et l'ID de requête de l'appel d'API. La méthode getMetadata() renvoie un tableau qui se présente comme suit:

object(Google\Ads\GoogleAds\Lib\V19\GoogleAdsResponseMetadata)#51 (1) {
  ["metadata":"Google\Ads\GoogleAds\Lib\V19\GoogleAdsResponseMetadata":private]=>
  array(17) {
    ["content-disposition"]=>
    array(1) {
      [0]=>
      string(10) "attachment"
    }
    ["request-id"]=>
    array(1) {
      [0]=>
      string(22) "REQUEST_ID"
    }
    ...
  }
}

La méthode getRequestId() simplifie l'extraction de l'ID de requête à partir du tableau de métadonnées, ce qui vous évite d'avoir à l'analyser manuellement.

Les sections suivantes expliquent comment récupérer GoogleAdsResponseMetadata pour chaque méthode.

SearchStream

Pour obtenir un objet GoogleAdsResponseMetadata, appelez getResponseMetadata() sur l'objet stream:

$stream = $googleAdsServiceClient->searchStream(
    SearchGoogleAdsStreamRequest::build($customerId, $query),
    ['withResponseMetadata' => true]
);

// Prints the request ID.
print $stream->getResponseMetadata()->getRequestId() . PHP_EOL;

$stream->getResponseMetadata() est un objet de GoogleAdsResponseMetadata.

Recherche et autres méthodes de mutation

Pour obtenir un objet GoogleAdsResponseMetadata, appelez getResponseMetadata() sur l'objet client:

// Retrieves objects.
$response = $googleAdsServiceClient->search(
    SearchGoogleAdsRequest::build($customerId, $query),
    ['withResponseMetadata' => true]
);

// Prints the request ID.
print $googleAdsServiceClient->getResponseMetadata()->getRequestId() . PHP_EOL;

// Mutates campaigns.
$response = $campaignServiceClient->mutateCampaigns(
    MutateCampaignsRequest::build($customerId, $campaignOperations),
    ['withResponseMetadata' => true]
);

// Prints the request ID.
print $campaignServiceClient->getResponseMetadata()->getRequestId() . PHP_EOL;

$campaignServiceClient->getResponseMetadata() et $googleAdsServiceClient->getResponseMetadata() sont des objets GoogleAdsResponseMetadata.