- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- InsightsAudience
- InsightsAudienceAttributeGroup
- AudienceCompositionSection
- AudienceCompositionAttribute
- AudienceCompositionMetrics
- AudienceCompositionAttributeCluster
- 試してみる
対象のオーディエンスに含まれる属性のコレクションを返します。各属性のオーディエンスの割合とベースライン オーディエンスのシェアを比較する指標が含まれます。
スローされるエラーのリスト: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
HTTP リクエスト
POST https://googleads.googleapis.com/v14/customers/{customerId}:generateAudienceCompositionInsights
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
customerId |
必須。顧客の ID。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "audience": { object ( |
フィールド | |
---|---|
audience |
必須。インサイトがリクエストされている対象オーディエンス。 |
baselineAudience |
関心のあるオーディエンスと比較されるベースライン オーディエンスです。 |
dataMonth |
分析情報に使用する過去のデータの 1 か月範囲(「yyyy-mm」形式)。未設定のままにすると、過去 30 日間のデータに関する分析情報が返されます。 |
dimensions[] |
必須。楽曲に関する分析情報を返すオーディエンス ディメンション。 |
customerInsightsGroup |
予定されているお客様の名前。これはユーザー定義の値です。 |
レスポンスの本文
AudienceInsightsService.GenerateAudienceCompositionInsights
に対するレスポンス メッセージです。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"sections": [
{
object ( |
フィールド | |
---|---|
sections[] |
セクション別に整理されたインサイト レポートの内容。各セクションは、リクエスト内の AudienceInsightsDimension 値の 1 つに関連付けられます。1 つのディメンションに複数のセクションが存在することがあります。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/adwords
詳細については、OAuth 2.0 の概要をご覧ください。
InsightsAudience
さまざまな特性によって定義されたユーザーの集合。AudienceInsightsService で分析情報をリクエストできます。
JSON 表現 |
---|
{ "countryLocations": [ { object ( |
フィールド | |
---|---|
countryLocations[] |
必須。オーディエンスの国。 |
subCountryLocations[] |
国の地理的位置属性。指定する場合は、それぞれがこのオーディエンスのいずれかの国に含まれている必要があります。指定されていない場合、オーディエンスは countryLocations の地理的位置に含まれ、それ以上はありません。 |
gender |
オーディエンスの性別。指定しない場合、オーディエンスは性別による制限を受けません。 |
ageRanges[] |
オーディエンスの年齢層。オーディエンスが存在しない場合、オーディエンスは他の属性に一致する 18 歳以上のすべてのユーザーを表します。 |
parentalStatus |
オーディエンスの子供の有無。指定されていない場合、オーディエンスは子供の有無による制限を受けません。 |
incomeRanges[] |
オーディエンスの世帯収入のパーセンタイル範囲。指定されていない場合、オーディエンスは世帯収入の範囲による制限を受けません。 |
dynamicLineups[] |
視聴者が視聴した YouTube コンテンツを表す動的ラインナップ。 |
topicAudienceCombinations[] |
エンティティ、カテゴリ、興味 / 関心の各属性の組み合わせで、オーディエンスを定義します。その組み合わせは AND 論理演算子(OR)の構造になっています。つまり、各 InsightsAudienceAttributeGroup 内の属性は OR で結合され、組み合わせ自体は AND で結合されます。たとえば、(Entity OR Affinity) AND (In-Market OR Category) の式は、それぞれ 2 つの属性を含む 2 つの InsightsAudienceAttributeGroups を使用して形成できます。 |
InsightsAudienceAttributeGroup
AudienceInsightsAttributes のリスト。
JSON 表現 |
---|
{
"attributes": [
{
object ( |
フィールド | |
---|---|
attributes[] |
必須。論理 OR で結合して組み合わせたオーディエンス属性のコレクションです。すべての属性が同じディメンションである必要はありません。ここでは、ナレッジグラフ エンティティ、商品とサービスのカテゴリ、アフィニティと購買意向の強いオーディエンスのみがサポートされます。 |
AudienceCompositionSection
オーディエンス構成の分析レポートに含まれる、同じ種類の関連属性のコレクションです。
JSON 表現 |
---|
{ "dimension": enum ( |
フィールド | |
---|---|
dimension |
このセクションの属性のタイプ。 |
topAttributes[] |
このオーディエンスと最も関連性の高いセグメントです。ディメンションが GENDER、AGE_RANGE、または PARENTAL_STATUS の場合、この属性のリストは網羅的です。 |
clusteredAttributes[] |
このオーディエンスの追加属性(クラスタにグループ化)。ディメンションが YOUTUBE_CHANNEL の場合にのみ入力されます。 |
AudienceCompositionAttribute
メタデータと指標を含むオーディエンス属性。
JSON 表現 |
---|
{ "attributeMetadata": { object ( |
フィールド | |
---|---|
attributeMetadata |
属性とそのメタデータ。 |
metrics |
属性の指標を共有し、インデックスに登録します。 |
AudienceCompositionMetrics
オーディエンス構成の分析レポートで、属性に関連付けられているシェアとインデックスの指標。
JSON 表現 |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
フィールド | |
---|---|
baselineAudienceShare |
ベースライン オーディエンスで属性に一致する割合(0 ~ 1)。 |
audienceShare |
この属性に一致する特定のオーディエンスの割合(0 ~ 1)。 |
index |
manifestAudienceShare に対する AudienceShare の比率。この比率が定義されていない場合、または有意でない場合にはゼロになります。 |
score |
0 ~ 1 の関連性スコア。 |
AudienceCompositionAttributeCluster
オーディエンス構成の分析レポートに含まれる、関連する属性のコレクション(メタデータと指標を含む)。
JSON 表現 |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
フィールド | |
---|---|
clusterDisplayName |
この属性のクラスタの名前 |
clusterMetrics |
このクラスタに関連付けられているディメンションが YOUTUBE_CHANNEL の場合、clusterMetrics はクラスタ全体に関連付けられている指標です。他のディメンションの場合、このフィールドは設定されません。 |
attributes[] |
このクラスタを構成する個々の属性(メタデータと指標を含む)。 |