Antwortmetadaten

Die PHP-Clientbibliothek protokolliert standardmäßig die Antwortmetadaten, einschließlich einer Anfrage-ID. Alternativ können Sie die Antwortmetadaten auch programmatisch abrufen, wenn Sie Clientdienstmethoden aufrufen. Dazu setzen Sie den optionalen Parameter withResponseMetadata auf true.

Nachdem Sie Clientdienstmethoden aufgerufen haben, können Sie GoogleAdsResponseMetadata von einem relevanten Objekt wie einem Dienstclient oder einem Stream abrufen, je nachdem, welche Methode Sie aufrufen. Dieses Objekt enthält getMetadata() und getRequestId(), die jeweils Antwortmetadaten und die Anfrage-ID des API-Aufrufs zurückgeben. Die Methode getMetadata() gibt ein Array zurück, das so aussieht:

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"
    }
    ...
  }
}

Mit der getRequestId()-Methode wird das Extrahieren der Anfrage-ID aus dem Metadatenarray vereinfacht, sodass Sie sie nicht manuell parsen müssen.

In den folgenden Abschnitten wird erläutert, wie Sie GoogleAdsResponseMetadata für jede Methode abrufen.

SearchStream

Wenn du ein GoogleAdsResponseMetadata-Objekt abrufen möchtest, rufe getResponseMetadata() auf das stream-Objekt auf:

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

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

Das $stream->getResponseMetadata() ist ein Objekt von GoogleAdsResponseMetadata.

Such- und andere Mutaionsmethoden

Wenn du ein GoogleAdsResponseMetadata-Objekt abrufen möchtest, rufe getResponseMetadata() auf das client-Objekt auf:

// 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() und $googleAdsServiceClient->getResponseMetadata() sind Objekte von GoogleAdsResponseMetadata.