ReportRequest Data Object - การรายงาน

บทความ
12/21/2023

กําหนดวัตถุพื้นฐานสําหรับคําขอรายงานทั้งหมด

ไม่ต้องสร้างอินสแตนซ์ของวัตถุนี้ แต่คุณอาจสร้างอินสแตนซ์หนึ่งวัตถุที่ร้องขอรายงานซึ่งมาจากวัตถุนี้ ตัวอย่างเช่น CampaignPerformanceReportRequest สําหรับรายการของรายงาน ให้ดูคู่มือประเภทรายงาน

ไวยากรณ์

<xs:complexType name="ReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ExcludeColumnHeaders" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportFooter" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportHeader" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
    <xs:element minOccurs="0" name="FormatVersion" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>

องค์ ประกอบ

วัตถุ ReportRequest มีองค์ประกอบต่อไปนี้: ExcludeColumnHeaders, ExcludeReportFooter, ExcludeReportHeader, Format, FormatVersion, ReportName, ReturnOnlyCompleteData

องค์ ประกอบ	คำอธิบาย	ชนิดข้อมูล
ExcludeColumnHeaders	กําหนดว่ารายงานที่ดาวน์โหลดควรประกอบด้วยคําอธิบายส่วนหัวสําหรับแต่ละคอลัมน์หรือไม่ ส่วนหัวของคอลัมน์รายงานตรงกับชื่อคอลัมน์ที่ร้องขอ เช่น การแสดงผลและการคลิก ตั้งค่าคุณสมบัตินี้ เป็นจริง ถ้าคุณต้องการให้ส่วนหัวของคอลัมน์รายงานไม่รวมอยู่ในรายงานที่ดาวน์โหลด ค่าเริ่มต้นคือ เท็จ	บูลีน
ExcludeReportFooter	กําหนดว่ารายงานที่ดาวน์โหลดควรประกอบด้วยเมตาดาต้าท้ายกระดาษ เช่น ลิขสิทธิ์ของ Microsoft (@2020 Microsoft Corporation หรือไม่ All rights reserved.) ตั้งค่าคุณสมบัตินี้ เป็นจริง ถ้าคุณต้องการให้เมตาดาต้าส่วนท้ายของรายงานถูกแยกออกจากรายงานที่ดาวน์โหลด ค่าเริ่มต้นคือ เท็จ	บูลีน
ExcludeReportHeader	กําหนดว่ารายงานที่ดาวน์โหลดควรประกอบด้วยเมตาดาต้าส่วนหัว เช่น ชื่อรายงาน ช่วงวันที่ และการรวมหรือไม่ ตั้งค่าคุณสมบัตินี้ เป็นจริง ถ้าคุณต้องการให้เมตาดาต้าส่วนหัวของรายงานถูกแยกออกจากรายงานที่ดาวน์โหลด ค่าเริ่มต้นคือ เท็จ	บูลีน
รูป แบบ	รูปแบบของข้อมูลรายงาน ตัวอย่างเช่น คุณสามารถร้องขอข้อมูลในรูปแบบค่าที่คั่นด้วยเครื่องหมายจุลภาค (Csv) หรือรูปแบบค่าที่คั่นด้วยแท็บ (Tsv) ค่าเริ่มต้นคือ Csv ไฟล์ที่ดาวน์โหลดทั้งหมดจะถูกบีบอัด ZIP	ReportFormat
FormatVersion	กําหนดรูปแบบสําหรับเขตข้อมูลบางอย่างในไฟล์รายงานที่ดาวน์โหลด รูปแบบข้อมูลสําหรับเขตข้อมูลบางอย่างสามารถอัปเดตได้ภายในเวอร์ชัน API ปัจจุบันโดยไม่ทําให้แอปพลิเคชันไคลเอ็นต์ที่มีอยู่เสียหาย คุณสามารถรับรูปแบบข้อมูลล่าสุดได้โดยการตั้งค่าเขตข้อมูลคําขอทางเลือกนี้เป็น 2.0 ถ้าคุณไม่ได้ตั้งค่าฟิลด์นี้ บริการจะใช้ค่าเริ่มต้นเป็นเวอร์ชัน 1.0 สําหรับรายละเอียดเกี่ยวกับการเปลี่ยนแปลงระหว่างเวอร์ชันรูปแบบ ดูเวอร์ชันของรูปแบบรายงาน	สาย อักขระ
ReportName	ชื่อของรายงาน ชื่อจะรวมอยู่ในส่วนหัวของรายงาน ถ้าคุณไม่ได้ระบุชื่อรายงาน ระบบจะสร้างชื่อในแบบฟอร์ม ReportType-ReportDateTime ความยาวสูงสุดของชื่อรายงานคือ 200	สาย อักขระ
ReturnOnlyCompleteData	กําหนดว่าบริการต้องตรวจสอบให้แน่ใจว่าข้อมูลทั้งหมดได้รับการประมวลผลแล้วและพร้อมใช้งานหรือไม่ ถ้าตั้งค่าเป็น true และถ้าระบบยังไม่เสร็จสิ้นการประมวลผลข้อมูลทั้งหมดตามการรวม ขอบเขต และเวลาที่ร้องขอ บริการจะส่งกลับรหัสข้อผิดพลาด NoCompleteDataAvaliable (2004) มิฉะนั้นตามค่าเริ่มต้นคําขอสามารถประสบความสําเร็จไม่มีข้อบ่งชี้ว่าข้อมูลเสร็จสมบูรณ์หรือไม่และรายงานจะมีเฉพาะข้อมูลที่ระบบประมวลผลเสร็จสิ้นในเวลาที่คําขอ โปรดทราบว่าเนื่องจากวันนี้ยังอยู่ระหว่างดําเนินการและข้อมูลไม่สมบูรณ์ คุณไม่สามารถตั้งค่าองค์ประกอบนี้เป็น จริง ถ้าช่วงเวลา (ไม่ว่าจะเป็นวันที่แบบกําหนดเองหรือวันที่กําหนดไว้ล่วงหน้า) รวมวันที่ของวันนี้ สําหรับข้อมูลเพิ่มเติม ดูโซนเวลาในการรายงาน	บูลีน

ข้อกําหนด

บริการ: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

ใช้โดย

SubmitGenerateReport

แชร์ผ่าน