Reports

ดูรายการเมธอดสําหรับทรัพยากรนี้ที่ท้ายหน้านี้

การนําเสนอแหล่งข้อมูล

รายงาน DoubleClick Search ออบเจ็กต์นี้มีคําขอรายงาน ข้อมูลเมตาของรายงานบางรายการ เช่น รหัสสกุลเงิน และแถวในรายงานหรือไฟล์รายงานที่สร้างขึ้น

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "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
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
files[] list รายงานแบบไม่พร้อมกันเท่านั้น มีรายการไฟล์รายงานที่สร้างขึ้นเมื่อรายงานเสร็จสมบูรณ์แล้ว
files[].byteCount long ขนาดของไฟล์รายงานนี้ในหน่วยไบต์
files[].url string ใช้ URL นี้เพื่อดาวน์โหลดไฟล์รายงาน
id string รายงานแบบไม่พร้อมกันเท่านั้น รหัสของรายงาน
isReportReady boolean รายงานแบบไม่พร้อมกันเท่านั้น เป็นจริงหากรายงานเสร็จสมบูรณ์แล้วเท่านั้น และไฟล์รายงานพร้อมให้ดาวน์โหลด
kind string ระบุว่าเป็นทรัพยากรของรายงาน ค่า: สตริงคงที่ doubleclicksearch#report
request nested object คําขอที่สร้างรายงาน ช่องที่ไม่บังคับซึ่งไม่ได้ระบุในคําขอเดิมจะมีการกรอกเป็นค่าเริ่มต้น
request.columns[] list คอลัมน์ที่จะรวมในรายงาน ซึ่งรวมทั้งคอลัมน์ DoubleClick Search และคอลัมน์ที่บันทึกไว้ เฉพาะคอลัมน์ columnName เท่านั้นที่ต้องใช้คอลัมน์ DoubleClick Search คอลัมน์ที่บันทึกไว้ต้องมีพารามิเตอร์ savedColumnName เท่านั้น ทั้ง columnName และ savedColumnName ไม่สามารถตั้งค่าในมาตรฐานเดียวกัน

จํานวนคอลัมน์สูงสุดต่อคําขอคือ 300 คอลัมน์

request.columns[].columnName string ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน
request.columns[].customDimensionName string แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion

request.columns[].customMetricName string ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่
request.columns[].endDate string วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate
request.columns[].groupByColumn boolean รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false
request.columns[].headerText string ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน
request.columns[].platformSource string แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight"
request.columns[].productReportPerspective string แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
  • "sold": แสดงเมตริกสําหรับผลิตภัณฑ์ที่ขายเท่านั้น
  • "advertised": แสดงผลเมตริกสําหรับผลิตภัณฑ์ที่โฆษณาในแคมเปญ Shopping เท่านั้น และอาจจะขายหรือไม่ขาย
request.columns[].savedColumnName string ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว
request.columns[].startDate string วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate
request.downloadFormat string รูปแบบที่ควรส่งคืนรายงาน ปัจจุบันรองรับ csv หรือ tsv
request.filters[] list รายการตัวกรองที่จะใช้กับรายงาน

จํานวนตัวกรองสูงสุดต่อคําขอคือ 300 รายการ

request.filters[].column nested object คอลัมน์เพื่อใช้ตัวกรอง ซึ่งอาจเป็นคอลัมน์ DoubleClick Search หรือคอลัมน์ที่บันทึกไว้
request.filters[].column.columnName string ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน
request.filters[].column.customDimensionName string แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion

request.filters[].column.customMetricName string ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่
request.filters[].column.endDate string วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate
request.filters[].column.groupByColumn boolean รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false
request.filters[].column.headerText string ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน
request.filters[].column.platformSource string แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight"
request.filters[].column.productReportPerspective string แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
  • "sold": แสดงเมตริกสําหรับผลิตภัณฑ์ที่ขายเท่านั้น
  • "advertised": แสดงผลเมตริกสําหรับผลิตภัณฑ์ที่โฆษณาในแคมเปญ Shopping เท่านั้น และอาจจะขายหรือไม่ขาย
request.filters[].column.savedColumnName string ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว
request.filters[].column.startDate string วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate
request.filters[].operator string โอเปอเรเตอร์ที่จะใช้ในตัวกรอง โปรดดูข้อมูลอ้างอิงตัวกรองสําหรับรายชื่อโอเปอเรเตอร์ที่ใช้ได้
request.filters[].values[] list รายการค่าที่ใช้กรองค่าคอลัมน์

ค่าของตัวกรองสูงสุดต่อคําขอคือ 300 รายการ

request.includeDeletedEntities boolean กําหนดว่าควรนําเอนทิตีที่นําออกแล้วออกจากรายงานหรือไม่ ค่าเริ่มต้นคือ false เลิกใช้งานแล้ว โปรดใช้ includeRemovedEntities แทน
request.includeRemovedEntities boolean กําหนดว่าควรนําเอนทิตีที่นําออกแล้วออกจากรายงานหรือไม่ ค่าเริ่มต้นคือ false
request.maxRowsPerFile integer รายงานแบบไม่พร้อมกันเท่านั้น จํานวนแถวสูงสุดต่อไฟล์รายงาน รายงานขนาดใหญ่จะแบ่งออกเป็นไฟล์จํานวนมากตามช่องนี้ ค่าที่ยอมรับคือ 1000000 ถึง 100000000
request.orderBy[] list รายงานแบบพร้อมกันเท่านั้น รายการคอลัมน์และเส้นทางที่กําหนดการจัดเรียงที่จะดําเนินการในแถวรายงาน

จํานวนสูงสุดของคําสั่งซื้อต่อคําขอคือ 300 รายการ

request.orderBy[].column nested object คอลัมน์เพื่อดําเนินการจัดเรียง โดยอาจเป็นคอลัมน์ที่ DoubleClick Search กําหนดหรือคอลัมน์ที่บันทึกไว้
request.orderBy[].column.columnName string ชื่อของคอลัมน์ DoubleClick Search ที่จะรวมไว้ในรายงาน
request.orderBy[].column.customDimensionName string แบ่งกลุ่มรายงานตามมิติข้อมูลที่กําหนดเอง รายงานต้องกําหนดขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่ามิติข้อมูลที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อมิติข้อมูลที่กําหนดเองซึ่งปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

หากใช้ในรายงาน Conversion จะแสดงค่าของมิติข้อมูลที่กําหนดเองที่ระบุสําหรับ Conversion ที่ระบุ (หากตั้งค่าไว้) คอลัมน์นี้ไม่ได้แบ่งกลุ่มรายงาน Conversion

request.orderBy[].column.customMetricName string ชื่อของเมตริกที่กําหนดเองที่จะรวมไว้ในรายงาน รายงานนี้ต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องตั้งค่าเมตริกที่กําหนดเองใน DoubleClick Search ไว้แล้ว ชื่อเมตริกที่กําหนดเองที่ปรากฏใน DoubleClick Search คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่
request.orderBy[].column.endDate string วันที่ระบุในรูปแบบ YYYY-MM-DD หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ startDate
request.orderBy[].column.groupByColumn boolean รายงานแบบพร้อมกันเท่านั้น ตั้งค่าเป็น true เพื่อจัดกลุ่มตามคอลัมน์นี้ ค่าเริ่มต้นคือ false
request.orderBy[].column.headerText string ข้อความที่ใช้ในการระบุคอลัมน์นี้ในเอาต์พุตของรายงาน ค่าเริ่มต้นคือ columnName หรือ savedColumnName เมื่อไม่ได้ระบุ ซึ่งจะช่วยป้องกันไม่ให้เกิดการขัดแย้งระหว่างคอลัมน์ DoubleClick Search กับคอลัมน์ที่บันทึกไว้ที่มีชื่อเดียวกัน
request.orderBy[].column.platformSource string แพลตฟอร์มที่ใช้ในการระบุข้อมูลสําหรับมิติข้อมูลที่กําหนดเอง ค่าที่ยอมรับคือ "floodlight"
request.orderBy[].column.productReportPerspective string แสดงเมตริกสําหรับกิจกรรมผลิตภัณฑ์บางประเภทเท่านั้น โดยค่าที่ยอมรับมีดังต่อไปนี้
  • "sold": แสดงเมตริกสําหรับผลิตภัณฑ์ที่ขายเท่านั้น
  • "advertised": แสดงผลเมตริกสําหรับผลิตภัณฑ์ที่โฆษณาในแคมเปญ Shopping เท่านั้น และอาจจะขายหรือไม่ขาย
request.orderBy[].column.savedColumnName string ชื่อของคอลัมน์ที่บันทึกไว้ที่จะรวมไว้ในรายงาน รายงานต้องมีขอบเขตระดับผู้ลงโฆษณาหรือต่ํากว่า และต้องสร้างคอลัมน์ที่บันทึกไว้นี้ใน UI ของ DoubleClick Search อยู่แล้ว
request.orderBy[].column.startDate string วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว หากระบุ ข้อมูลนี้จะลบล้างช่วงเวลาโดยรวมของรายงานสําหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ endDate
request.orderBy[].sortOrder string ทิศทางการจัดเรียง ซึ่งก็คือ ascending หรือ descending
request.reportScope object reportScope คือชุดรหัสที่ใช้เพื่อระบุว่าเอนทิตีใดจะแสดงในรายงาน คุณต้องระบุรหัสที่สมบูรณ์จากระดับขอบเขตต่ําสุดที่ต้องการผ่านเอเจนซี
request.reportScope.adGroupId long รหัสกลุ่มโฆษณา DS
request.reportScope.adId long รหัสโฆษณา DS
request.reportScope.advertiserId long รหัสผู้ลงโฆษณา DS
request.reportScope.agencyId long รหัสเอเจนซี DS
request.reportScope.campaignId long รหัสแคมเปญ DS
request.reportScope.engineAccountId long รหัสบัญชีเครื่องมือค้นหา DS
request.reportScope.keywordId long รหัสคีย์เวิร์ด DS
request.reportType string ระบุประเภทของแถวที่แสดงในรายงาน ตัวอย่างเช่น หากคุณระบุ reportType: keyword แต่ละแถวในรายงานจะมีข้อมูลเกี่ยวกับคีย์เวิร์ด ดูข้อมูลอ้างอิงประเภทรายงานสําหรับคอลัมน์ที่พร้อมใช้งานในแต่ละประเภท
request.rowCount integer รายงานแบบพร้อมกันเท่านั้น จํานวนแถวสูงสุดที่จะแสดง แถวเพิ่มเติมจะหายไป ค่าที่ยอมรับคือ 0 ถึง 10000 ค่าเริ่มต้นคือ 10000
request.startRow integer รายงานแบบพร้อมกันเท่านั้น ดัชนีแบบ 0 แถวแรกของแถวที่ส่งคืน ค่าที่ยอมรับคือ 0 ถึง 50000 ค่าเริ่มต้นคือ 0
request.statisticsCurrency string ระบุสกุลเงินสําหรับการคืนสินค้า ค่าที่เป็นไปได้ ได้แก่ usd, agency (ถูกต้องหากรายงานมีขอบเขตเป็นเอเจนซีหรือต่ํากว่า) advertiser (ใช้ได้กับรายงานที่มีขอบเขตเป็น * ผู้ลงโฆษณาหรือต่ํากว่า) หรือ account (ถูกต้องหากรายงานอยู่ในขอบเขตบัญชีเครื่องมือค้นหาหรือต่ํากว่า)
request.timeRange object หากมีการขอเมตริกในรายงาน ระบบจะใช้อาร์กิวเมนต์นี้เพื่อจํากัดเมตริกตามระยะเวลาที่เจาะจง
request.timeRange.changedAttributesSinceTimestamp datetime การประทับเวลา UTC ที่ไม่ครอบคลุมในรูปแบบ RFC เช่น 2013-07-16T10:16:23.555Z ดูข้อมูลอ้างอิงเพิ่มเติมเกี่ยวกับวิธีการทํางานของรายงานแอตทริบิวต์ที่เปลี่ยนแปลง
request.timeRange.changedMetricsSinceTimestamp datetime การประทับเวลา UTC ที่ไม่ครอบคลุมในรูปแบบ RFC เช่น 2013-07-16T10:16:23.555Z ดูข้อมูลอ้างอิงเพิ่มเติมเกี่ยวกับวิธีการทํางานของรายงานเมตริกที่เปลี่ยนแปลง
request.timeRange.endDate string วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว
request.timeRange.startDate string วันที่ครอบคลุมในรูปแบบ ปปปป-ดด-วว
request.verifySingleTimeZone boolean หาก true ระบบจะสร้างรายงานก็ต่อเมื่อข้อมูลสถิติที่ขอทั้งหมดมาจากเขตเวลาเดียว ค่าเริ่มต้นคือ false
rowCount integer จํานวนแถวรายงานที่สร้างโดยรายงาน ไม่รวมส่วนหัว
rows[] list รายงานแบบพร้อมกันเท่านั้น สร้างแถวรายงานแล้ว
rows[].(key) any value ระบุคอลัมน์ที่แสดงในแถวนี้ กล่าวคือ แต่ละคีย์จะสอดคล้องกับคอลัมน์ที่มีเซลล์ว่างในแถวนี้
statisticsCurrencyCode string รหัสสกุลเงินของมูลค่าทางการเงินทั้งหมดที่แสดงในรายงาน รวมถึงค่าที่ผู้ใช้กําหนด (เช่น การตั้งค่าการเสนอราคาระดับคีย์เวิร์ด) และเมตริก (เช่น ค่าใช้จ่ายและรายได้) รหัสสกุลเงินของรายงานจะกําหนดโดยช่อง statisticsCurrency ของคําขอรายงาน
statisticsTimeZone string หากสถิติทั้งหมดของรายงานมีแหล่งที่มาจากเขตเวลาเดียวกัน จะเป็นเวลานี้ หรือไม่ได้ตั้งค่าช่องนี้

วิธีการ

สร้าง
สร้างและส่งคืนรายงานทันที
รับ
แบบสํารวจสําหรับสถานะของคําขอรายงาน
รับไฟล์
ดาวน์โหลดไฟล์รายงานที่เข้ารหัสใน UTF-8
getIdMappingFile
ดาวน์โหลดไฟล์ CSV (ที่เข้ารหัสใน UTF-8) ที่มีการแมปรหัสระหว่าง Search Ads 360 แบบเก่ากับ Search Ads 360 เวอร์ชันใหม่ สําหรับผู้ลงโฆษณาที่ขอ ไฟล์นี้ประกอบด้วยเอนทิตีย่อยทั้งหมด (เช่น บัญชีเครื่องมือค้นหา แคมเปญ กลุ่มโฆษณา ฯลฯ) ที่มีอยู่ใน Search Ads 360 แบบเก่าและ Search Ads 360 เวอร์ชันใหม่
คําขอ
แทรกคําขอรายงานลงในระบบการรายงาน