Method: customers.generateAudienceCompositionInsights

傳回對感興趣目標對象代表的一組屬性,並提供指標,比較每項屬性與基準目標對象的佔比。

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

HTTP 要求

POST https://googleads.googleapis.com/v14/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 總覽

InsightsAudience

由各種特性定義的使用者組合,可在 AudienceInsightsService 中要求取得洞察資訊。

JSON 表示法
{
  "countryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "subCountryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "gender": {
    object (GenderInfo)
  },
  "ageRanges": [
    {
      object (AgeRangeInfo)
    }
  ],
  "parentalStatus": {
    object (ParentalStatusInfo)
  },
  "incomeRanges": [
    {
      object (IncomeRangeInfo)
    }
  ],
  "dynamicLineups": [
    {
      object (AudienceInsightsDynamicLineup)
    }
  ],
  "topicAudienceCombinations": [
    {
      object (InsightsAudienceAttributeGroup)
    }
  ]
}
欄位
countryLocations[]

object (LocationInfo)

必要欄位。觀眾的國家/地區。

subCountryLocations[]

object (LocationInfo)

國家/地區子位置屬性。如有指定,每個群組都必須包含在這組目標對象的其中一個國家/地區中。如未提供,目標對象就會根據國家/地區位置來推測目標對象。

gender

object (GenderInfo)

目標對象的性別。如果沒有,目標對象就不會受到性別限制。

ageRanges[]

object (AgeRangeInfo)

目標對象的年齡層。如未選取,目標對象代表符合其他屬性且年滿 18 歲的所有人。

parentalStatus

object (ParentalStatusInfo)

目標對象的家長狀態。如果沒有選取,目標對象就不會受到家長狀態限制。

incomeRanges[]

object (IncomeRangeInfo)

目標對象的家庭收入百分位數範圍。如果沒有,目標對象就不會受到家庭收入範圍限制。

dynamicLineups[]

object (AudienceInsightsDynamicLineup)

代表觀眾收看的 YouTube 內容的動態首選頻道。

topicAudienceCombinations[]

object (InsightsAudienceAttributeGroup)

用來定義目標對象的實體、類別和使用者興趣屬性組合。組合採用邏輯「和」邏輯結構:每個 InsightsAudienceAttributeGroup 中的屬性都會與 OR 合併,而這些組合本身也會搭配 AND 使用。舉例來說,運算式 (實體「或」興趣相似目標對象) AND (潛在目標消費者 OR 類別) 可以使用兩個 InsightsAudienceAttributeGroup 建立要加入的洞察目標對象屬性,每個屬性各包含兩個屬性。

InsightsAudienceAttributeGroup

AudienceInsights 屬性清單。

JSON 表示法
{
  "attributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ]
}
欄位
attributes[]

object (AudienceInsightsAttribute)

必要欄位。一組目標對象屬性要搭配邏輯「OR」合併。屬性不需要全都是相同維度。這項功能僅支援知識圖譜實體、產品和服務類別,以及興趣相似目標對象和潛在目標消費者。

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,含 1)。

audienceShare

number

與屬性相符的特定目標對象分數 (從 0 到 1,含首尾)。

index

number

目標對像比重與基準目標對象共用的比率;如果這個比例未定義或沒有意義,則為零。

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)

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