Method: properties.audienceLists.query

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

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

กลุ่มเป้าหมายใน 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)

ข้อมูลการกำหนดค่าเกี่ยวกับ AudienceList ที่กำลังค้นหา ส่งคืนเพื่อช่วยตีความแถวของกลุ่มเป้าหมายในการตอบกลับนี้ เช่น มิติข้อมูลใน AudienceList นี้จะสอดคล้องกับคอลัมน์ใน 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
ช่อง
ค่ามิติข้อมูลประเภทหนึ่ง ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องใดช่องหนึ่งต่อไปนี้ในการตอบกลับ
value

string

ค่าเป็นสตริงหากประเภทมิติข้อมูลเป็นสตริง
สิ้นสุดฟิลด์ที่แยกกัน