Antwortmetadaten

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

Nachdem Sie Clientdienstmethoden aufgerufen haben, können Sie GoogleAdsResponseMetadata aus 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\V21\GoogleAdsResponseMetadata)#51 (1) {
  ["metadata":"Google\Ads\GoogleAds\Lib\V21\GoogleAdsResponseMetadata":private]=>
  array(17) {
    ["content-disposition"]=>
    array(1) {
      [0]=>
      string(10) "attachment"
    }
    ["request-id"]=>
    array(1) {
      [0]=>
      string(22) "REQUEST_ID"
    }
    ...
  }
}

Die Methode getRequestId() vereinfacht das Extrahieren der Anforderungs-ID aus dem Metadaten-Array, sodass Sie sie nicht manuell parsen müssen.

In den folgenden Abschnitten wird erläutert, wie Sie GoogleAdsResponseMetadata für die einzelnen Methoden abrufen.

SearchStream

Wenn Sie ein Objekt von GoogleAdsResponseMetadata abrufen möchten, rufen Sie getResponseMetadata() für 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 Mutationsmethoden

Rufen Sie getResponseMetadata() für das client-Objekt auf, um ein Objekt von GoogleAdsResponseMetadata zu erhalten:

// 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 ein Objekt von GoogleAdsResponseMetadata.