ภาพรวม

Reporting API

Reporting API ช่วยให้ผู้ขายมีส่วนร่วมกับข้อมูลประสิทธิภาพได้อย่างเป็นโปรแกรมผ่านภาษาการค้นหาของ Merchant Center ซึ่งคล้ายกับความสามารถในการสร้างรายงานที่กำหนดเองใน Merchant Center โดยตรง Reporting API มีประโยชน์ดังต่อไปนี้

• ช่วยให้ผู้ขายรายใหญ่นำเข้าข้อมูลประสิทธิภาพของข้อมูลผลิตภัณฑ์ที่แสดงเข้าสู่ระบบการรายงานภายในหรือของบุคคลที่สามได้
• อนุญาตให้ผู้ใช้ พาร์ทเนอร์บุคคลที่สาม และผู้รวบรวมข้อมูลที่จัดการบัญชี Merchant Center เข้าถึงการรายงานได้

ผู้ใช้ API สามารถระบุข้อมูลประสิทธิภาพที่ต้องการดึงมาในการตอบกลับการเรียกใช้การค้นหา เช่น

• เมตริกที่จะแสดง (เช่น การคลิก การแสดงผล)
• มิติข้อมูลที่จะใช้แบ่งกลุ่มข้อมูล (เช่น OfferId, วันที่)
• เงื่อนไขที่ต้องปฏิบัติตาม (เช่น จำนวนคลิก > 100)

ภาษาในการค้นหา Reporting API จะค้นหาเมตริกประสิทธิภาพ (การคลิก การแสดงผล) ของ Reporting API เพื่อค้นหาเมตริกประสิทธิภาพ (การคลิก การแสดงผล) ได้ (แอตทริบิวต์ของเหตุการณ์ที่รายงาน เช่น โปรแกรมและวันที่ รวมถึงแอตทริบิวต์ผลิตภัณฑ์ เช่น แบรนด์ หมวดหมู่ ฯลฯ) โดยใช้เมธอด Search ในบริการ Reports

ผลลัพธ์จากการค้นหาไปยังบริการ Reports จะแสดงรายการอินสแตนซ์ ReportRow โดย ReportRow แต่ละรายการจะแสดงค่าของเมตริกที่ขอสำหรับกลุ่มที่คุณระบุในการค้นหา หากไม่ได้ระบุกลุ่มไว้ ระบบจะแสดงแถวเดียวพร้อมด้วยเมตริกที่รวบรวมจากกลุ่มทั้งหมด มิเช่นนั้น หากมีการขอกลุ่มควบคู่ไปกับเมตริก การตอบกลับจะแสดง 1 แถวสำหรับ Tuple กลุ่มที่ไม่ซ้ำกันแต่ละกลุ่ม คุณสามารถเลือกกลุ่มหลายกลุ่มและหลายเมตริกในคำค้นหาเดียวได้

การค้นหาเมตริก

คุณค้นหาเมตริก (การคลิก, การแสดงผล, CTR ฯลฯ) ที่ต้องการให้ส่งกลับได้ คุณต้องเพิ่มตัวกรองในช่วงวันที่เพื่อค้นหาบริการรายงาน ข้อความค้นหาตัวอย่างด้านล่างแสดงแถวเดียว: จำนวนคลิกรวมภายในเงื่อนไขที่เพิ่มของช่วงวันที่

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

ตัวอย่างการตอบกลับ

ตัวอย่างการตอบกลับของโค้ด JSON ด้านล่างแสดงให้เห็นว่าผู้ขายรายนี้มีการคลิกรวม 4,440 ครั้งในผลิตภัณฑ์ทั้งหมดในปลายทางทั้งหมดระหว่างวันที่ 1 ธันวาคม 2020 ถึง 21 ธันวาคม 2020 ได้อย่างไร

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

การค้นหากลุ่ม

นอกจากเมตริกแล้ว คุณยังค้นหากลุ่มซึ่งอาจเป็นแอตทริบิวต์ของผลิตภัณฑ์ (offer_id, brand, category ฯลฯ) หรือแอตทริบิวต์ของเหตุการณ์ที่รายงาน (date, program) ได้ด้วย เหตุการณ์ที่รายงานคือการแสดงผลหรือการคลิกของผลิตภัณฑ์

กลุ่มทำหน้าที่คล้ายกับ GROUP BY ใน SQL กลุ่มจะแบ่งเมตริกที่เลือก โดยจัดกลุ่มตามแต่ละกลุ่มในวลี SELECT ข้อความค้นหาตัวอย่างด้านล่างแสดงจำนวนคลิกต่อวัน เรียงลำดับตามจำนวนคลิกจากมากไปน้อยภายในเงื่อนไขที่เพิ่มของช่วงวันที่ ระบบจะแสดงผลเฉพาะแถวที่มีเมตริกที่ขออย่างน้อย 1 รายการที่ไม่ใช่ 0 เท่านั้น

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

ตัวอย่างการตอบกลับ

ตัวอย่างการตอบกลับของโค้ด JSON ด้านล่างแสดงให้เห็นว่าผู้ขายรายนี้ได้รับคลิก 1,546 ครั้งในผลิตภัณฑ์ทั้งหมดในปลายทางทั้งหมดในวันที่ 1 ธันวาคม 2020 และได้รับการคลิก 829 ครั้งในผลิตภัณฑ์ทั้งหมดในปลายทางทั้งหมดในวันที่ 2 ธันวาคม 2020 ระบบจะไม่ส่งคืนออบเจ็กต์ในวันที่ 3 ธันวาคม 2020 เนื่องจากผู้ขายไม่มีการคลิกในวันนั้น

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}