สร้างและแสดงผลรายงานทันที ลองใช้เลย
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports/generate
การให้สิทธิ์
คําขอนี้ต้องได้รับอนุญาตจากขอบเขตต่อไปนี้
ขอบเขต |
---|
https://www.googleapis.com/auth/doubleclicksearch |
สําหรับข้อมูลเพิ่มเติม โปรดดูหน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
ในเนื้อหาคําขอ ให้ระบุข้อมูลที่มีโครงสร้างต่อไปนี้
{ "reportScope": { "agencyId": long, "advertiserId": long, "engineAccountId": long, "campaignId": long, "adGroupId": long, "keywordId": long, "adId": long }, "reportType": string, "columns": [ { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string } ], "timeRange": { "startDate": string, "endDate": string, "changedMetricsSinceTimestamp": datetime, "changedAttributesSinceTimestamp": datetime }, "filters": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "operator": string, "values": [ (value) ] } ], "orderBy": [ { "column": { "columnName": string, "savedColumnName": string, "customDimensionName": string, "customMetricName": string, "headerText": string, "startDate": string, "endDate": string, "groupByColumn": boolean, "platformSource": string, "productReportPerspective": string }, "sortOrder": string } ], "includeDeletedEntities": boolean, "includeRemovedEntities": boolean, "verifySingleTimeZone": boolean, "downloadFormat": string, "statisticsCurrency": string, "startRow": integer, "rowCount": integer, "maxRowsPerFile": integer }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
reportScope |
object |
reportScope คือชุดรหัสที่ใช้เพื่อระบุว่าเอนทิตีใดจะแสดงในรายงาน คุณต้องระบุรหัสที่สมบูรณ์จากระดับขอบเขตต่ําสุดที่ต้องการผ่านเอเจนซี | |
reportScope.agencyId |
long |
รหัสเอเจนซี DS | |
reportScope.advertiserId |
long |
รหัสผู้ลงโฆษณา DS | |
reportScope.engineAccountId |
long |
รหัสบัญชีเครื่องมือค้นหา DS | |
reportScope.campaignId |
long |
รหัสแคมเปญ DS | |
reportScope.adGroupId |
long |
รหัสกลุ่มโฆษณา DS | |
reportScope.keywordId |
long |
รหัสคีย์เวิร์ด DS | |
reportScope.adId |
long |
รหัสโฆษณา DS | |
reportType |
string |
ระบุประเภทของแถวที่แสดงในรายงาน ตัวอย่างเช่น หากคุณระบุ reportType: keyword แต่ละแถวในรายงานจะมีข้อมูลเกี่ยวกับคีย์เวิร์ด ดูข้อมูลอ้างอิงประเภทรายงานสําหรับคอลัมน์ที่พร้อมใช้งานในแต่ละประเภท |
|
columns[] |
list |
คอลัมน์ที่จะรวมในรายงาน ซึ่งรวมทั้งคอลัมน์ DoubleClick Search และคอลัมน์ที่บันทึกไว้ เฉพาะคอลัมน์ columnName เท่านั้นที่ต้องใช้คอลัมน์ DoubleClick Search คอลัมน์ที่บันทึกไว้ต้องมีพารามิเตอร์ savedColumnName เท่านั้น ทั้ง columnName และ savedColumnName ไม่สามารถตั้งค่าในมาตรฐานเดียวกัน จํานวนคอลัมน์สูงสุดต่อคําขอคือ 300 คอลัมน์ |
|
columns[].columnName |
string |
ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน | |
columns[].savedColumnName |
string |
ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว | |
columns[].headerText |
string |
ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน |
|
columns[].startDate |
string |
วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate |
|
columns[].endDate |
string |
วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate |
|
columns[].groupByColumn |
boolean |
รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false |
|
timeRange |
object |
หากมีการขอเมตริกในรายงาน ระบบจะใช้อาร์กิวเมนต์นี้เพื่อจํากัดเมตริกตามระยะเวลาที่เจาะจง | |
timeRange.startDate |
string |
วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว | |
timeRange.endDate |
string |
วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว | |
timeRange.changedMetricsSinceTimestamp |
datetime |
การประทับเวลา UTC ที่ไม่ครอบคลุมในรูปแบบ RFC เช่น 2013-07-16T10:16:23.555Z ดูข้อมูลอ้างอิงเพิ่มเติมเกี่ยวกับวิธีการทํางานของรายงานเมตริกที่เปลี่ยนแปลง |
|
timeRange.changedAttributesSinceTimestamp |
datetime |
การประทับเวลา UTC ที่ไม่ครอบคลุมในรูปแบบ RFC เช่น 2013-07-16T10:16:23.555Z ดูข้อมูลอ้างอิงเพิ่มเติมเกี่ยวกับวิธีการทํางานของรายงานแอตทริบิวต์ที่เปลี่ยนแปลง |
|
filters[] |
list |
รายการตัวกรองที่จะใช้กับรายงาน จํานวนตัวกรองสูงสุดต่อคําขอคือ 300 รายการ |
|
filters[].column |
nested object |
คอลัมน์เพื่อใช้ตัวกรอง ซึ่งอาจเป็นคอลัมน์ DoubleClick Search หรือคอลัมน์ที่บันทึกไว้ | |
filters[].column.columnName |
string |
ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน | |
filters[].column.savedColumnName |
string |
ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว | |
filters[].operator |
string |
โอเปอเรเตอร์ที่จะใช้ในตัวกรอง โปรดดูข้อมูลอ้างอิงตัวกรองสําหรับรายชื่อโอเปอเรเตอร์ที่ใช้ได้ | |
filters[].values[] |
list |
รายการค่าที่ใช้กรองค่าคอลัมน์ ค่าของตัวกรองสูงสุดต่อคําขอคือ 300 รายการ |
|
orderBy[] |
list |
รายงานแบบพร้อมกันเท่านั้น รายการคอลัมน์และเส้นทางที่กําหนดการจัดเรียงที่จะดําเนินการในแถวรายงาน จํานวนสูงสุดของคําสั่งซื้อต่อคําขอคือ 300 รายการ |
|
orderBy[].column |
nested object |
คอลัมน์เพื่อดําเนินการจัดเรียง โดยอาจเป็นคอลัมน์ที่ DoubleClick Search กําหนดหรือคอลัมน์ที่บันทึกไว้ | |
orderBy[].column.columnName |
string |
ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน | |
orderBy[].column.savedColumnName |
string |
ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว | |
orderBy[].sortOrder |
string |
ทิศทางการจัดเรียง ซึ่งก็คือ ascending หรือ descending |
|
includeDeletedEntities |
boolean |
กําหนดว่าควรนําเอนทิตีที่นําออกแล้วออกจากรายงานหรือไม่ ค่าเริ่มต้นคือ false เลิกใช้งานแล้ว โปรดใช้ includeRemovedEntities แทน |
|
verifySingleTimeZone |
boolean |
หาก true ระบบจะสร้างรายงานก็ต่อเมื่อข้อมูลสถิติที่ขอทั้งหมดมาจากเขตเวลาเดียว ค่าเริ่มต้นคือ false |
|
downloadFormat |
string |
รูปแบบที่ควรส่งคืนรายงาน ปัจจุบันรองรับ csv หรือ tsv |
|
statisticsCurrency |
string |
ระบุสกุลเงินสําหรับการคืนสินค้า ค่าที่เป็นไปได้ ได้แก่ usd , agency (ถูกต้องหากรายงานมีขอบเขตเป็นเอเจนซีหรือต่ํากว่า) advertiser (ใช้ได้กับรายงานที่มีขอบเขตเป็น * ผู้ลงโฆษณาหรือต่ํากว่า) หรือ account (ถูกต้องหากรายงานอยู่ในขอบเขตบัญชีเครื่องมือค้นหาหรือต่ํากว่า) |
|
startRow |
integer |
รายงานแบบพร้อมกันเท่านั้น ดัชนีแบบ 0 แถวแรกของแถวที่ส่งคืน ค่าที่ยอมรับคือ 0 ถึง 50000 ค่าเริ่มต้นคือ 0 |
|
rowCount |
integer |
รายงานแบบพร้อมกันเท่านั้น จํานวนแถวสูงสุดที่จะแสดง แถวเพิ่มเติมจะหายไป ค่าที่ยอมรับคือ 0 ถึง 10000 ค่าเริ่มต้นคือ 10000 |
|
maxRowsPerFile |
integer |
รายงานแบบไม่พร้อมกันเท่านั้น จํานวนแถวสูงสุดต่อไฟล์รายงาน รายงานขนาดใหญ่จะแบ่งออกเป็นไฟล์จํานวนมากตามช่องนี้ ค่าที่ยอมรับคือ 1000000 ถึง 100000000 |
|
includeRemovedEntities |
boolean |
กําหนดว่าควรนําเอนทิตีที่นําออกแล้วออกจากรายงานหรือไม่ ค่าเริ่มต้นคือ false |
|
columns[].customDimensionName |
string |
แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion |
|
columns[].platformSource |
string |
แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight" | |
filters[].column.customDimensionName |
string |
แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion |
|
filters[].column.headerText |
string |
ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน |
|
filters[].column.startDate |
string |
วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate |
|
filters[].column.endDate |
string |
วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate |
|
filters[].column.groupByColumn |
boolean |
รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false |
|
filters[].column.platformSource |
string |
แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight" | |
orderBy[].column.customDimensionName |
string |
แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion |
|
orderBy[].column.headerText |
string |
ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน |
|
orderBy[].column.startDate |
string |
วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate |
|
orderBy[].column.endDate |
string |
วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate |
|
orderBy[].column.groupByColumn |
boolean |
รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false |
|
orderBy[].column.platformSource |
string |
แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight" | |
columns[].customMetricName |
string |
ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ | |
filters[].column.customMetricName |
string |
ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ | |
orderBy[].column.customMetricName |
string |
ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ | |
columns[].productReportPerspective |
string |
แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
|
|
filters[].column.productReportPerspective |
string |
แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
|
|
orderBy[].column.productReportPerspective |
string |
แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
|
คำตอบ
หากสําเร็จวิธีนี้จะแสดงทรัพยากรรายงานในส่วนเนื้อหาของการตอบกลับ
ลองใช้เลย
ใช้เครื่องมือสํารวจ API ด้านล่างเพื่อเรียกใช้วิธีการนี้สําหรับข้อมูลสดและดูการตอบกลับ หรือลองใช้ เครื่องมือสํารวจแบบสแตนด์อโลน