Metadata Respons

Library klien PHP mencatat metadata respons, termasuk ID permintaan, secara default. Atau, Anda dapat memperoleh metadata respons secara terprogram saat memanggil metode layanan klien dengan menetapkan parameter opsional withResponseMetadata ke true.

Setelah memanggil metode layanan klien, Anda kemudian dapat memperoleh GoogleAdsResponseMetadata, dari objek yang relevan, seperti klien layanan atau streaming, sesuai dengan metode yang Anda panggil. Objek ini berisi getMetadata() dan getRequestId(), yang masing-masing menampilkan metadata respons dan ID permintaan panggilan API. Metode getMetadata() menampilkan array yang terlihat seperti ini:

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

Metode getRequestId() menyederhanakan proses ekstraksi ID permintaan dari array metadata, sehingga Anda tidak perlu mem-parsingnya secara manual.

Bagian berikut menjelaskan cara mengambil GoogleAdsResponseMetadata untuk setiap metode.

SearchStream

Untuk mendapatkan objek GoogleAdsResponseMetadata, panggil getResponseMetadata() pada objek stream:

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

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

$stream->getResponseMetadata() adalah objek dari GoogleAdsResponseMetadata.

Metode penelusuran dan mutasi lainnya

Untuk mendapatkan objek GoogleAdsResponseMetadata, panggil getResponseMetadata() pada objek klien:

// 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() dan $googleAdsServiceClient->getResponseMetadata() adalah objek GoogleAdsResponseMetadata.