Method: properties.audienceLists.query

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

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

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

วิธีการนี้พร้อมใช้งานสำหรับความเสถียรของรุ่นเบต้าที่ audienceExports.query หากต้องการแสดงความคิดเห็นเกี่ยวกับ API นี้ โปรดกรอกความคิดเห็นเกี่ยวกับ Audience Export 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)

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

integer

จำนวนแถวทั้งหมดในผลลัพธ์ AudienceList 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 ค่ามิติข้อมูลประเภทหนึ่ง one_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
value

string

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