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 
{

  // 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

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