Method: properties.audienceLists.exportSheet

ส่งออกรายการกลุ่มเป้าหมายของผู้ใช้ไปยังสเปรดชีตใน Google ชีต หลังจากสร้างกลุ่มเป้าหมายแล้ว ผู้ใช้จะเข้าถึงข้อมูลไม่ได้ในทันที โดยก่อนอื่น ต้องส่งคำขอไปยัง audienceLists.create เพื่อสร้างรายการกลุ่มเป้าหมายของผู้ใช้ และครั้งที่ 2 ใช้วิธีนี้เพื่อส่งออกผู้ใช้เหล่านั้นในรายการกลุ่มเป้าหมายไปยังสเปรดชีตใน Google ชีต

ดูการสร้างรายการกลุ่มเป้าหมายสำหรับข้อมูลเบื้องต้นเกี่ยวกับรายการกลุ่มเป้าหมายพร้อมตัวอย่าง

กลุ่มเป้าหมายใน Google Analytics 4 ช่วยให้คุณแบ่งกลุ่มผู้ใช้ในรูปแบบที่สําคัญต่อธุรกิจได้ ดูข้อมูลเพิ่มเติมได้ที่ https://support.google.com/analytics/answer/9267572

วิธีการนี้จะช่วยให้มีความเสถียรในเวอร์ชันอัลฟ่า โดยมีจุดประสงค์เพื่อรวบรวมความคิดเห็นเกี่ยวกับไวยากรณ์และความสามารถต่างๆ ก่อนเข้าสู่เวอร์ชันเบต้า หากต้องการแสดงความคิดเห็นเกี่ยวกับ API นี้ โปรดกรอกแบบฟอร์มความคิดเห็นเกี่ยวกับ API การส่งออกกลุ่มเป้าหมายของ Google Analytics

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ต้องระบุ ชื่อรายการกลุ่มเป้าหมายที่จะดึงผู้ใช้มา รูปแบบ: properties/{property}/audienceLists/{audienceList}

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "offset": string,
  "limit": string
}
ช่อง
offset

string (int64 format)

ไม่บังคับ จำนวนแถวของแถวเริ่มต้น แถวแรกจะนับเป็นแถว 0

เมื่อแบ่งหน้า คำขอแรกไม่ได้ระบุออฟเซ็ต หรือเทียบเท่า ตั้งค่าออฟเซ็ตเป็น 0 คำขอแรกแสดงผล limit แถวแรกของแถว คำขอที่ 2 กำหนดออฟเซ็ตเป็น limit ของคำขอแรก คำขอที่ 2 จะแสดงผล limit แถวที่ 2 ของแถว

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า
limit

string (int64 format)

ไม่บังคับ จำนวนแถวที่จะแสดงผล หากไม่ระบุ ระบบจะแสดงผล 10,000 แถว API จะส่งกลับจำนวนแถวสูงสุด 250,000 แถวต่อคำขอ ไม่ว่าคุณจะขอกี่แถวก็ตาม limit ต้องเป็นค่าบวก

นอกจากนี้ API อาจแสดงผลแถวน้อยกว่า limit ที่ขอด้วย หากมีค่ามิติข้อมูลไม่มากเท่ากับ limit

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า

เนื้อหาการตอบกลับ

สเปรดชีตใน Google ชีตที่สร้างขึ้นซึ่งมีรายชื่อผู้ใช้ในรายการกลุ่มเป้าหมาย

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
ช่อง
spreadsheetUri

string

URI สำหรับเข้าชมในเบราว์เซอร์เพื่อดูสเปรดชีตใน Google ชีต
spreadsheetId

string

รหัสที่ระบุทรัพยากรใน Google ชีตที่สร้างขึ้น
rowCount

integer

จำนวนแถวทั้งหมดในผลลัพธ์รายการกลุ่มเป้าหมาย rowCount ไม่ขึ้นอยู่กับจำนวนแถวที่แสดงผลในการตอบกลับ พารามิเตอร์คำขอ limit และพารามิเตอร์คำขอ offset ตัวอย่างเช่น หากการค้นหาแสดงผล 175 แถวและรวม limit จาก 50 แถวในคำขอ API การตอบกลับจะมี rowCount จาก 175 แถว แต่มีเพียง 50 แถวเท่านั้น

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์การใส่เลขหน้านี้ได้ที่การใส่เลขหน้า
audienceList

object (AudienceList)

ข้อมูลการกําหนดค่าเกี่ยวกับรายการกลุ่มเป้าหมายที่จะส่งออก แสดงผลเพื่อช่วยตีความรายการกลุ่มเป้าหมายใน Google ชีตของคำตอบนี้

เช่น รายการกลุ่มเป้าหมายอาจมีแถวมากกว่าที่แสดงใน Google ชีต ในกรณีนี้คุณอาจต้องส่งคำขอส่งออกชีตเพิ่มเติมที่มีค่า offset อื่นเพื่อดึงข้อมูลแถวหน้าถัดไปใน Google ชีตเพิ่มเติม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets