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 และคอลัมน์ที่บันทึกไว้ สำหรับคอลัมน์ DoubleClick Search จำเป็นต้องใช้พารามิเตอร์ columnName เท่านั้น คอลัมน์ที่บันทึกไว้มีเพียงพารามิเตอร์ 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 วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ 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 วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ 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 วันที่รวมในรูปแบบ YYYY-MM-DD เมื่อมีการระบุไว้ การดำเนินการนี้จะแทนที่ช่วงเวลาโดยรวมของรายงานสำหรับคอลัมน์นี้เท่านั้น ต้องระบุพร้อมกับ 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 วันที่รวมในรูปแบบ YYYY-MM-DD
request.timeRange.startDate string วันที่รวมในรูปแบบ YYYY-MM-DD
request.verifySingleTimeZone boolean หากเป็น true ระบบจะสร้างรายงานก็ต่อเมื่อข้อมูลสถิติที่ขอทั้งหมดมาจากเขตเวลาเดียว ค่าเริ่มต้นคือ false
rowCount integer จำนวนแถวในรายงานที่สร้างโดยรายงาน ไม่รวมส่วนหัว
rows[] list รายงานแบบซิงโครนัสเท่านั้น สร้างแถวในรายงานแล้ว
rows[].(key) any value ระบุคอลัมน์ที่แสดงในแถวนี้ กล่าวคือ แต่ละคีย์จะสอดคล้องกับคอลัมน์ที่มีเซลล์ที่ไม่ว่างเปล่าในแถวนี้
statisticsCurrencyCode string รหัสสกุลเงินของมูลค่าทางการเงินทั้งหมดที่เกิดขึ้นในรายงาน รวมถึงมูลค่าที่ผู้ใช้กำหนด (เช่น การตั้งค่าการเสนอราคาระดับคีย์เวิร์ด) และเมตริก (เช่น ต้นทุนและรายได้) รหัสสกุลเงินของรายงานกำหนดโดยช่อง statisticsCurrency ของคำขอรายงาน
statisticsTimeZone string หากสถิติทั้งหมดของรายงานมีที่มาจากเขตเวลาเดียวกัน มิฉะนั้นระบบจะไม่ตั้งค่าช่องดังกล่าว

เมธอด

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