Method: customers.generateAudienceCompositionInsights

対象のオーディエンスに含まれる属性のコレクションと、各属性のオーディエンスのシェアとベースライン オーディエンスのシェアを比較する指標を返します。

スローされるエラーのリスト: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

分析情報に使用する履歴データの 1 か月間の範囲。形式は「yyyy-mm」です。未設定のままにした場合、過去 30 日間のデータに関する分析情報が返されます。
dimensions[]

enum (AudienceInsightsDimension)

必須。楽曲の分析情報を返すオーディエンス ディメンション。
customerInsightsGroup

string

予約予定の顧客の名前。これはユーザー定義の値です。

レスポンスの本文

AudienceInsightsService.GenerateAudienceCompositionInsights に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "sections": [
    {
      object (AudienceCompositionSection)
    }
  ]
}
フィールド
sections[]

object (AudienceCompositionSection)

セクションに整理された分析情報レポートの内容。各セクションは、リクエストの AudienceInsightsDimension 値のいずれかに関連付けられます。1 つのディメンションに複数のセクションが存在する場合があります。

認可スコープ

次の 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

baselineAudienceShare に対する audienceShare の比率。この比率が未定義または有意でない場合は、0。
score

number

0 ～ 1 の関連性スコア（両端を含む）。

AudienceCompositionAttributeCluster

オーディエンス構成の分析レポートに表示される、関連する属性のコレクション（メタデータと指標を含む）。

JSON 表現 
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
フィールド
clusterDisplayName

string

この属性クラスタの名前
clusterMetrics

object (AudienceCompositionMetrics)

このクラスタに関連付けられているディメンションが YOUTUBE_CHANNEL の場合、clusterMetrics はクラスタ全体に関連付けられた指標です。他のディメンションでは、このフィールドは設定されません。
attributes[]

object (AudienceCompositionAttribute)

このクラスタを構成する個々の属性（メタデータと指標を含む）。