SOAP XML 請求和回應標頭

本頁提供必要的 SOAP XML 請求標頭，以及回應中傳回的標頭。

必要的要求標頭

所有 API SOAP 呼叫的標頭中都必須有 <RequestHeader> 元素。所有 WSDL 服務都會定義此元素。用戶端程式庫提供 方法，利用您提供的值為您新增此標頭。以下是 <RequestHeader> 所有元素的說明：

元素 說明
<networkCode>

要處理的網路代碼。提出所有要求時，都需要網路代碼 (NetworkService.getAllNetworks() 和 NetworkService.makeTestNetwork() 除外)。

請確認只使用帳戶登入帳戶可用的聯播網代碼。您可以在 Google Ad Manager 網站上前往 [管理] > [「聯播網代碼」旁的「聯播網設定」頁面。
<applicationName> 用來識別應用程式的任意字串名稱。這項資訊會顯示在 Google 的記錄檔中。例如：「我的廣告空間」 應用程式」或「App_1」。

注意：應用程式傳送至 Ad Manager API 的每個請求都必須包含 OAuth2 存取權杖。將權杖透過 HTTP 標頭傳遞為：Authorization: Bearer YOUR_ACCESS_TOKEN。

要求範例

以下程式碼是對 getAdUnitsByStatement() 的 SOAP 請求呼叫來尋找根 AdUnit。

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header>
    <ns1:RequestHeader
         soapenv:actor="http://schemas.xmlsoap.org/soap/actor/next"
         soapenv:mustUnderstand="0"
         xmlns:ns1="https://www.google.com/apis/ads/publisher/v202408">
      <ns1:networkCode>123456</ns1:networkCode>
      <ns1:applicationName>DfpApi-Java-2.1.0-dfp_test</ns1:applicationName>
    </ns1:RequestHeader>
  </soapenv:Header>
  <soapenv:Body>
    <getAdUnitsByStatement xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <filterStatement>
        <query>WHERE parentId IS NULL LIMIT 500</query>
      </filterStatement>
    </getAdUnitsByStatement>
  </soapenv:Body>
</soapenv:Envelope>

注意：如果 SOAP 請求造成 Unmarshalling error，請參閱常見錯誤中的疑難排解提示。

回應標頭

API 傳回的所有回應都包含下列標頭元素。阿斯 最佳做法，建議您記錄這些值。

元素 說明
<requestId> 識別此請求的專屬編號。如有任何支援問題，請傳送 這個 ID 可讓我們更快找到您的要求。
<responseTime> 網路服務從接收請求到傳送要求之間經過的時間 回應。

回應範例

下列程式碼是先前請求的 SOAP 回應範例。

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ResponseHeader xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <rval>
        <totalResultSetSize>1</totalResultSetSize>
        <startIndex>0</startIndex>
        <results>
          <id>2372</id>
          <name>RootAdUnit</name>
          <description></description>
          <targetWindow>TOP</targetWindow>
          <status>ACTIVE</status>
          <adUnitCode>1002372</adUnitCode>
          <inheritedAdSenseSettings>
            <value>
              <adSenseEnabled>true</adSenseEnabled>
              <borderColor>FFFFFF</borderColor>
              <titleColor>0000FF</titleColor>
              <backgroundColor>FFFFFF</backgroundColor>
              <textColor>000000</textColor>
              <urlColor>008000</urlColor>
              <adType>TEXT_AND_IMAGE</adType>
              <borderStyle>DEFAULT</borderStyle>
              <fontFamily>DEFAULT</fontFamily>
              <fontSize>DEFAULT</fontSize>
            </value>
          </inheritedAdSenseSettings>
        </results>
      </rval>
    </getAdUnitsByStatementResponse>
  </soap:Body>
</soap:Envelope>