レスポンスのメタデータ

PHP クライアント ライブラリはデフォルトで、リクエスト ID などのレスポンス メタデータをログに記録します。または、オプションのパラメータ withResponseMetadata を true に設定することで、クライアント サービスのメソッドを呼び出すときにレスポンス メタデータをプログラムで取得することもできます。

クエリを GoogleAdsService.SearchStream() に送信し、withResponseMetadata を true に設定する例を次に示します。

[$response, $metadata] = $googleAdsServiceClient->searchStream(
    $customerId,
    $query,
    ['withResponseMetadata' => true]
);

SearchGoogleAdsStreamResponse のクエリ結果で構成される $response を含む配列が返されます。

配列の 2 番目のメンバー $metadata は、metadata フィールド自体が配列であるレスポンス メタデータを保持します。

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

リクエスト ID は、GoogleAdsResponseMetadata::getRequestId() を使用する場合と同様に request-id キーから取得できます。