Method: properties.audienceLists.query

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

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

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

วิธีนี้ใช้ได้ที่ความเสถียรของเวอร์ชันเบต้าที่ audienceExports.query หากต้องการแสดงความคิดเห็นเกี่ยวกับ API นี้ โปรดกรอกแบบฟอร์มความคิดเห็นเกี่ยวกับ API การส่งออกกลุ่มเป้าหมายของ Google Analytics

คำขอ HTTP

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

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

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

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

รายชื่อผู้ใช้ในรายการกลุ่มเป้าหมาย

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

การแสดง JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
ช่อง
audienceRows[]

object (AudienceRow)

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

object (AudienceList)

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

integer

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

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

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

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

แอตทริบิวต์ค่ามิติข้อมูลสำหรับแถวผู้ใช้ของกลุ่มเป้าหมาย

การแสดง JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
ช่อง
dimensionValues[]

object (AudienceDimensionValue)

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

AudienceDimensionValue

ค่าของมิติข้อมูล

การแสดง JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
ช่อง
ช่องการรวม one_value ค่ามิติข้อมูล 1 ค่า one_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
value

string

ค่าเป็นสตริง ถ้าประเภทมิติข้อมูลเป็นสตริง