SOAP XML Request and Response Headers

این صفحه اطلاعاتی در مورد سرصفحه های درخواست SOAP XML و سرصفحه هایی که در پاسخ برگردانده می شوند را ارائه می دهد.

سرصفحه های درخواستی مورد نیاز

همه تماس‌های API SOAP باید یک عنصر <RequestHeader> در سربرگ داشته باشند. این عنصر در تمام WSDL های سرویس تعریف شده است. کتابخانه های سرویس گیرنده با استفاده از مقادیری که ارائه می کنید، روش هایی را برای اضافه کردن این سربرگ برای شما ارائه می دهند. در اینجا شرحی از تمام عناصر <RequestHeader> آمده است:

عنصر توضیحات
<networkCode>

کد شبکه شبکه در حال آدرس دهی کدهای شبکه هنگام انجام همه درخواست ها به جز NetworkService.getAllNetworks() و NetworkService.makeTestNetwork() مورد نیاز است.

مطمئن شوید که فقط از یک کد شبکه موجود برای ورود به حساب خود استفاده می کنید. می‌توانید کد را در وب‌سایت Google Ad Manager مربوط به حساب خود، در صفحه Admin > Network Settings در کنار «کد شبکه» پیدا کنید.

<applicationName> یک نام رشته دلخواه که برنامه شما را شناسایی می کند. این در فایل های گزارش گوگل نشان داده خواهد شد. به عنوان مثال: "برنامه موجودی من" یا "App_1".

توجه: هر درخواستی که برنامه شما به Ad Manager API ارسال می‌کند باید شامل یک نشانه دسترسی OAuth2 باشد. رمز را در هدر HTTP به عنوان: Authorization: Bearer YOUR_ACCESS_TOKEN ارسال کنید.

درخواست نمونه

کد زیر نمونه ای از فراخوانی درخواست SOAP به getAdUnitsByStatement() است که به دنبال ریشه 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 > منحصر به فرد این درخواست را شناسایی می کند. اگر مشکلی در پشتیبانی دارید، ارسال این شناسه به ما کمک می‌کند تا درخواست شما را راحت‌تر پیدا کنیم.
<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>