หน้านี้มีข้อมูลเกี่ยวกับส่วนหัวของคำขอ SOAP XML ที่จำเป็น และส่วนหัวที่ส่งกลับในการตอบกลับ
ส่วนหัวของคำขอที่จำเป็น
การเรียก API SOAP ทั้งหมดต้องมีองค์ประกอบ <RequestHeader>
ในส่วนหัว องค์ประกอบนี้มีการกำหนดไว้ใน WSDL ของบริการทั้งหมด ไลบรารีของไคลเอ็นต์แสดงวิธีการเพิ่มส่วนหัวนี้ให้คุณโดยใช้ค่าที่คุณระบุ ต่อไปนี้คือคำอธิบายองค์ประกอบทั้งหมดของ <RequestHeader>
องค์ประกอบ | คำอธิบาย |
---|---|
<networkCode> |
รหัสเครือข่ายของเครือข่ายที่ระบุ ต้องระบุรหัสเครือข่ายเมื่อส่งคำขอทั้งหมดยกเว้น ตรวจสอบให้แน่ใจว่าคุณใช้เฉพาะรหัสเครือข่ายที่พร้อมใช้งานสำหรับการเข้าสู่ระบบบัญชีของคุณ คุณจะพบรหัสในเว็บไซต์ Google Ad Manager สำหรับบัญชีของคุณในหน้าผู้ดูแลระบบ > การตั้งค่าเครือข่าย ถัดจาก "รหัสเครือข่าย" |
<applicationName> |
ชื่อสตริงที่กำหนดเองซึ่งระบุแอปพลิเคชันของคุณ ข้อมูลนี้จะแสดงในไฟล์บันทึกของ Google เช่น "แอปพลิเคชัน พื้นที่โฆษณาของฉัน" หรือ "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/v202405"> <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/v202405"> <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/v202405"> <requestId>xxxxxxxxxxxxxxxxxxxx</requestId> <responseTime>1063</responseTime> </ResponseHeader> </soap:Header> <soap:Body> <getAdUnitsByStatementResponse xmlns="https://www.google.com/apis/ads/publisher/v202405"> <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>