Method: customers.generateAudienceCompositionInsights

傳回代表感興趣目標對象的一系列屬性,並提供相關指標,比較各屬性在目標對象與基準目標對像中的佔比。

擲回錯誤清單:AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP 要求

POST https://googleads.googleapis.com/v16/customers/{customerId}:generateAudienceCompositionInsights

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

必要欄位。客戶的 ID。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
欄位
audience

object (InsightsAudience)

必要欄位。要求取得其洞察資料的目標對象。

baselineAudience

object (InsightsAudience)

比較感興趣的目標對象的基準目標對象。

dataMonth

string

用於深入分析的一個月歷來資料範圍,格式為「yyyy-mm」。如未設定,系統會傳回最近三十天的洞察資料。

dimensions[]

enum (AudienceInsightsDimension)

必要欄位。要傳回樂曲洞察資料的目標對象維度。

customerInsightsGroup

string

預定進行遷移的客戶名稱。這是使用者定義的值,

回應主體

AudienceInsightsService.GenerateAudienceCompositionInsights」的回應訊息。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "sections": [
    {
      object (AudienceCompositionSection)
    }
  ]
}
欄位
sections[]

object (AudienceCompositionSection)

深入分析報表的內容,已分門別類。每個區段都與要求的其中一個 AudienceInsightsDimensions 值相關聯。每個維度可能有多個區塊。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/adwords

詳情請參閱 OAuth 2.0 總覽

AudienceCompositionSection

目標對象組成洞察報表中一系列相同類型的相關屬性。

JSON 表示法
{
  "dimension": enum (AudienceInsightsDimension),
  "topAttributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ],
  "clusteredAttributes": [
    {
      object (AudienceCompositionAttributeCluster)
    }
  ]
}
欄位
dimension

enum (AudienceInsightsDimension)

這個部分的屬性類型。

topAttributes[]

object (AudienceCompositionAttribute)

與這個目標對象最相關的區隔。如果維度為 GENDER、AGE_RANGE 或 PARENTAL_STATUS,請參閱這份完整屬性清單。

clusteredAttributes[]

object (AudienceCompositionAttributeCluster)

這個目標對象的其他屬性 (分組為多個叢集)。只有在維度為「YOUTUBE_CHANNEL」時才會填入資料。

AudienceCompositionAttribute

包含中繼資料和指標的目標對象屬性。

JSON 表示法
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
欄位
attributeMetadata

object (AudienceInsightsAttributeMetadata)

屬性和中繼資料。

metrics

object (AudienceCompositionMetrics)

屬性的共用指標及建立索引。

AudienceCompositionMetrics

在目標對象組成深入分析報表中,與屬性相關聯的比重和索引指標。

JSON 表示法
{
  "baselineAudienceShare": number,
  "audienceShare": number,
  "index": number,
  "score": number
}
欄位
baselineAudienceShare

number

符合屬性的基準目標對像比例 (含 0 到 1)。

audienceShare

number

符合屬性的特定目標對像比例 (含 0 到 1)。

index

number

AudienceShare 與 baselineAudienceShare 的比率。如果這個比率未定義或不具意義,則為 0。

score

number

關聯性分數,從 0 到 1 (含 0 和 1)。

AudienceCompositionAttributeCluster

目標對象組成深入分析報表中的一組相關屬性,包括中繼資料和指標。

JSON 表示法
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
欄位
clusterDisplayName

string

這個屬性叢集的名稱

clusterMetrics

object (AudienceCompositionMetrics)

如果與這個叢集相關聯的維度是 YOUTUBE_CHANNEL,則 clusterMetrics 是指與整個叢集相關聯的指標。其他維度則會設定這個欄位。

attributes[]

object (AudienceCompositionAttribute)

構成這個叢集的個別屬性,包含中繼資料和指標。