응답 메타데이터

PHP 클라이언트 라이브러리는 기본적으로 요청 ID를 포함한 응답 메타데이터를 로깅합니다. 또는 선택적 매개변수 withResponseMetadata를 true로 설정하여 클라이언트 서비스 메서드를 호출할 때 프로그래매틱 방식으로 응답 메타데이터를 가져올 수 있습니다.

클라이언트 서비스 메서드를 호출한 후 호출하는 메서드에 따라 서비스 클라이언트나 스트림과 같은 관련 객체에서 GoogleAdsResponseMetadata를 가져올 수 있습니다. 이 객체에는 응답 메타데이터와 API 호출의 요청 ID를 각각 반환하는 getMetadata() 및 getRequestId()가 포함되어 있습니다. getMetadata() 메서드는 다음과 같은 배열을 반환합니다.

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

getRequestId() 메서드는 메타데이터 배열에서 요청 ID를 추출하는 프로세스를 간소화하므로 수동으로 파싱하는 수고를 덜 수 있습니다.

다음 섹션에서는 각 메서드의 GoogleAdsResponseMetadata를 검색하는 방법을 설명합니다.

SearchStream

GoogleAdsResponseMetadata 객체를 가져오려면 스트림 객체에서 getResponseMetadata()를 호출합니다.

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

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

$stream->getResponseMetadata()는 GoogleAdsResponseMetadata의 객체입니다.

검색 및 기타 변형 메서드

GoogleAdsResponseMetadata 객체를 가져오려면 클라이언트 객체에서 getResponseMetadata()를 호출합니다.

// 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의 객체입니다.