SOAP XML অনুরোধ এবং প্রতিক্রিয়া শিরোনাম

এই পৃষ্ঠাটি প্রয়োজনীয় SOAP XML অনুরোধ শিরোনাম এবং প্রতিক্রিয়া হিসাবে ফিরে আসা হেডারগুলির তথ্য প্রদান করে৷

প্রয়োজনীয় অনুরোধ শিরোনাম

সমস্ত API SOAP কলের শিরোনামে একটি <RequestHeader> উপাদান থাকতে হবে; এই উপাদানটি সমস্ত পরিষেবা WSDL-এ সংজ্ঞায়িত করা হয়েছে। ক্লায়েন্ট লাইব্রেরিগুলি আপনার সরবরাহ করা মানগুলি ব্যবহার করে আপনার জন্য এই শিরোনামটি যুক্ত করার পদ্ধতি সরবরাহ করে। এখানে <RequestHeader> এর সমস্ত উপাদানের একটি বিবরণ রয়েছে:

উপাদান বর্ণনা
<networkCode>

নেটওয়ার্কের নেটওয়ার্ক কোড ঠিকানা হচ্ছে. NetworkService.getAllNetworks() এবং NetworkService.makeTestNetwork() ছাড়া সমস্ত অনুরোধ করার সময় নেটওয়ার্ক কোডের প্রয়োজন হয়।

নিশ্চিত করুন যে আপনি শুধুমাত্র আপনার অ্যাকাউন্ট লগইন করার জন্য উপলব্ধ একটি নেটওয়ার্ক কোড ব্যবহার করুন৷ আপনি "নেটওয়ার্ক কোড" এর পাশে অ্যাডমিন > নেটওয়ার্ক সেটিংস পৃষ্ঠায় আপনার অ্যাকাউন্টের জন্য Google অ্যাড ম্যানেজার ওয়েবসাইটে কোডটি খুঁজে পেতে পারেন।

<applicationName> একটি নির্বিচারে স্ট্রিং নাম আপনার অ্যাপ্লিকেশন সনাক্ত. এটি Google এর লগ ফাইলগুলিতে দেখানো হবে৷ উদাহরণস্বরূপ: "আমার ইনভেন্টরি অ্যাপ্লিকেশন" বা "অ্যাপ_1"।

দ্রষ্টব্য: আপনার অ্যাপ্লিকেশনটি অ্যাড ম্যানেজার এপিআই-এ পাঠানো প্রতিটি অনুরোধে অবশ্যই একটি OAuth2 অ্যাক্সেস টোকেন অন্তর্ভুক্ত করতে হবে। HTTP হেডারে টোকেনটি এইভাবে পাস করুন: Authorization: Bearer YOUR_ACCESS_TOKEN

উদাহরণ অনুরোধ

নিচের কোডটি getAdUnitsByStatement() রুট AdUnit খুঁজতে SOAP অনুরোধ কলের একটি উদাহরণ।

<?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/v202402">
      <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/v202402">
      <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/v202402">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202402">
      <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>
,

এই পৃষ্ঠাটি প্রয়োজনীয় SOAP XML অনুরোধ শিরোনাম এবং প্রতিক্রিয়া হিসাবে ফিরে আসা হেডারগুলির তথ্য প্রদান করে৷

প্রয়োজনীয় অনুরোধ শিরোনাম

সমস্ত API SOAP কলের শিরোনামে একটি <RequestHeader> উপাদান থাকতে হবে; এই উপাদানটি সমস্ত পরিষেবা WSDL-এ সংজ্ঞায়িত করা হয়েছে। ক্লায়েন্ট লাইব্রেরিগুলি আপনার সরবরাহ করা মানগুলি ব্যবহার করে আপনার জন্য এই শিরোনামটি যুক্ত করার পদ্ধতি সরবরাহ করে। এখানে <RequestHeader> এর সমস্ত উপাদানের একটি বিবরণ রয়েছে:

উপাদান বর্ণনা
<networkCode>

নেটওয়ার্কের নেটওয়ার্ক কোড ঠিকানা হচ্ছে. NetworkService.getAllNetworks() এবং NetworkService.makeTestNetwork() ছাড়া সমস্ত অনুরোধ করার সময় নেটওয়ার্ক কোডের প্রয়োজন হয়।

নিশ্চিত করুন যে আপনি শুধুমাত্র আপনার অ্যাকাউন্ট লগইন করার জন্য উপলব্ধ একটি নেটওয়ার্ক কোড ব্যবহার করুন৷ আপনি "নেটওয়ার্ক কোড" এর পাশে অ্যাডমিন > নেটওয়ার্ক সেটিংস পৃষ্ঠায় আপনার অ্যাকাউন্টের জন্য Google অ্যাড ম্যানেজার ওয়েবসাইটে কোডটি খুঁজে পেতে পারেন।

<applicationName> একটি নির্বিচারে স্ট্রিং নাম আপনার অ্যাপ্লিকেশন সনাক্ত. এটি Google এর লগ ফাইলগুলিতে দেখানো হবে৷ উদাহরণস্বরূপ: "আমার ইনভেন্টরি অ্যাপ্লিকেশন" বা "অ্যাপ_1"।

দ্রষ্টব্য: আপনার অ্যাপ্লিকেশনটি অ্যাড ম্যানেজার এপিআই-এ পাঠানো প্রতিটি অনুরোধে অবশ্যই একটি OAuth2 অ্যাক্সেস টোকেন অন্তর্ভুক্ত করতে হবে। HTTP হেডারে টোকেনটি এইভাবে পাস করুন: Authorization: Bearer YOUR_ACCESS_TOKEN

উদাহরণ অনুরোধ

নিচের কোডটি getAdUnitsByStatement() রুট AdUnit খুঁজতে SOAP অনুরোধ কলের একটি উদাহরণ।

<?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/v202402">
      <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/v202402">
      <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/v202402">
      <requestId>xxxxxxxxxxxxxxxxxxxx</requestId>
      <responseTime>1063</responseTime>
    </ResponseHeader>
  </soap:Header>
  <soap:Body>
    <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202402">
      <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>