בדף הזה מפורט מידע על הכותרות הנדרשות של בקשות XML מסוג SOAP ועל הכותרות שמוחזרות בתגובה.
כותרות נדרשות של בקשה
כל הקריאות ל-API SOAP חייבות לכלול רכיב <RequestHeader>
בכותרת. הרכיב הזה מוגדר בכל אסימוני ה-WSDL של השירות. ספריות הלקוח מספקות שיטות להוספת הכותרת הזו עבורכם, על סמך הערכים שאתם מספקים. הנה תיאור של כל הרכיבים של <RequestHeader>
:
רכיב | תיאור |
---|---|
<networkCode> |
קוד הרשת של הרשת שמצוינת כרגע. צריך להזין קודי רשת בכל הבקשות מלבד חשוב להקפיד להשתמש רק בקוד רשת שזמין להתחברות לחשבון. ניתן למצוא את הקוד באתר Google Ad Manager של החשבון, בדף 'ניהול' > 'הגדרות רשת' ליד 'קוד רשת'. |
<applicationName> |
שם של מחרוזת שרירותית שמזהה את האפליקציה שלך. השם הזה יופיע בקובצי היומן של Google. לדוגמה: "האפליקציה My Inventory" או "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/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>