แทรกคำขอรายงานลงในระบบการรายงาน ลองใช้เลย
ส่งคำขอ
คำขอ HTTP
POST https://www.googleapis.com/doubleclicksearch/v2/reports
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์ตามขอบเขตต่อไปนี้
| ขอบเขต | 
|---|
| 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 และคอลัมน์ที่บันทึกไว้ สำหรับคอลัมน์ DoubleClick Search จำเป็นต้องใช้พารามิเตอร์ columnNameเท่านั้น คอลัมน์ที่บันทึกไว้มีเพียงพารามิเตอร์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 | วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate | |
| columns[].endDate | string | วันแบบรวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate | |
| columns[].groupByColumn | boolean | รายงานแบบซิงโครนัสเท่านั้น ตั้งค่าเป็น trueเพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือfalse | |
| timeRange | object | หากมีการขอเมตริกในรายงาน ระบบจะใช้อาร์กิวเมนต์นี้เพื่อจำกัดเมตริกเป็นช่วงเวลาที่ต้องการ | |
| timeRange.startDate | string | วันที่รวมในรูปแบบ YYYY-MM-DD | |
| timeRange.endDate | string | วันที่รวมในรูปแบบ YYYY-MM-DD | |
| 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 | วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ 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 | วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ 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 Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ หรือจะลองใช้ สแตนด์อโลน สำรวจ
