レスポンスのメタデータ

PHP クライアント ライブラリがレスポンスをログに記録する メタデータ（リクエスト ID を含む）がデフォルトで提供されます。別の方法として、 使用してクライアント サービスのメソッドを呼び出す場合に、 省略可能なパラメータ withResponseMetadata を true に設定する。

クライアント サービスのメソッドを呼び出すと、以下を取得できます。 GoogleAdsResponseMetadata オブジェクトから（サービス クライアントやストリームなど）に 呼び出すことができます。このオブジェクトには getMetadata() と getRequestId() が含まれます。 レスポンスのメタデータと API 呼び出しのリクエスト ID をそれぞれ返します。 getMetadata() メソッドは、次のような配列を返します。

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

getRequestId() メソッドを使用すると、リクエスト ID を抽出するプロセスが簡単になります。 手動で解析する手間を省くことができます。

以降のセクションでは、Terraform で GoogleAdsResponseMetadata を取得する方法について説明します。 あります。

SearchStream

GoogleAdsResponseMetadata のオブジェクトを取得するには、getResponseMetadata() を呼び出します。 stream オブジェクト:

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

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

$stream->getResponseMetadata() は、 GoogleAdsResponseMetadata。

検索などの変更メソッド

GoogleAdsResponseMetadata のオブジェクトを取得するには、getResponseMetadata() を呼び出します。 を 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() と $googleAdsServiceClient->getResponseMetadata() は次のオブジェクト: GoogleAdsResponseMetadata。