Search
K

Marketing

マーケティングに関するアクション一覧です。

GetGAReport

概要

GetGAReportは、Googleアナリティクスからレポートを取得するアクションです。パラメーターを設定することで、カスタマイズされたレポートを作成することができます。レポートの対象期間は、startDate、endDateで設定します。取得したい値は、metricsで選択します。ページ別、ブラウザ別などの分析軸を設定したい場合は、dimensionsで指定します。リクエストで返されるディメンションまたは指標を制限したい場合は、filtersで指定します。また、mcf_reportをtrueにすることでマルチチャネルレポートデータを取得することが出来ます。返却されるレスポンスはデフォルトで最大1000行です。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
google analyticsからデータを取得するのに必要なプロバイダーID
ga_e7502c3b8b8147410ce2
mcf_report*
真理値
取得するレポートの種類を切り替えます。trueの場合、マルチチャネルレポートデータを取得します。
false
viewId*
文字列
ユーザーID
12345678
startDate*
文字列
リクエスト期間の開始日付
2019-04-01
endDate*
文字列
リクエスト期間の終了日付
2019-04-30
metrics*
文字列
指標(定量化されたデータ)。カンマ区切りで10個まで指定可能。
dimensions
文字列
ディメンション(データの属性)。カンマ区切りで7個まで指定可能
ga:browser
filters
文字列
リクエストで返されるデータを制限するディメンションまたは指標のフィルタ
ga:browser==Chrome
pageSize
数値
リクエストで返されるデータの数。最大で、100,000行。
1000 (デフォルト値)

補足: 入力フォーマット

すべての指標がすべてのディメンションと組み合わせることができるわけではありません。ディメンションと指標は、同じ階層のもの同士を組み合わせる必要があります。たとえば、「セッション」はセッションの指標なので、同じセッションレベルの「参照元」や「市区町村」などのディメンションと組み合わせます。「セッション」を「ページ」などのヒットレベルのディメンションと組み合わせても意味はありません。ディメンションと指標の有効な組み合わせについては、下記に記載したディメンションと指標の組み合わせの具体例を参照してください。
①新規ユーザーのセッション数を計測したい場合
action>: GetGAReport
provider: ga_xxxxxxx
mcf_report false
viewId: 11110000
startDate: '2019-04-01'
endDate: '2019-04-30'
metrics: ga:sessions
dimensions: ga:userType
filters: ga:userType==New Visitor
②任意の市町村区における平均セッション時間を計測したい場合
action>: GetGAReport
provider: ga_xxxxxx
mcf_report false
viewId: 11110000
startDate: '2019-04-01'
endDate: '2019-04-30'
metrics: ga:sessions
dimensions: ga:city
filters: ga:city==cityName
dimensionsとmetrixに関する詳細情報は下記のURLを参考にしてください。 https://developers.google.com/analytics/devguides/reporting/core/dimsmets

補足: 入力フォーマット(マルチチャネルレポートデータ)

マルチチャネルレポートデータを取得する場合、通常のGoogleアナリティクスからのレポート取得の際に使用するものとは異なる独自のディメンションと指標を使用する必要があります。 また、マルチチャネルレポートデータ取得用のディメンションと指標はすべて組み合わせることができます。
①参照元サイトの種類がemailのアシストコンバージョン数を計測したい場合
action>: GetGAReport
provider: ga_xxxxxxx
mcf_report true
viewId: 11110000
startDate: '2019-04-01'
endDate: '2019-04-30'
metrics: 'mcf:assistedConversions'
dimensions: 'mcf:medium'
filters: 'mcf:medium==email'
dimensionsとmetrixに関する詳細情報は下記のURLを参考にしてください。https://developers.google.com/analytics/devguides/reporting/mcf/dimsmets

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

action>: GetGAReport
provider: ga_xxxxxxxx
mcf_report: false
viewId: 1234567890
startDate: '2019-04-01'
endDate: '2019-04-30'
metrics: 'ga:users,ga:sessions'
dimensions: 'ga:browser'
# => {
# "reports": [
# {
# "columnHeader": {
# "dimensions": [
# "ga:browser"
# ],
# "metricHeader": {
# "metricHeaderEntries": [
# {
# "name": "ga:users",
# "type": "INTEGER"
# },
# {
# "name": "ga:sessions",
# "type": "INTEGER"
# }
# ]
# }
# },
# "data": {
# "rows": [
# {
# "dimensions": [
# "Chrome"
# ],
# "metrics": [
# {
# "values": [
# "3229",
# "4660"
# ]
# }
# ]
# },
# {
# "dimensions": [
# "Firefox"
# ],
# "metrics": [
# {
# "values": [
# "360",
# "480"
# ]
# }
# ]
# },
# {
# "dimensions": [
# "Internet Explorer"
# ],
# "metrics": [
# {
# "values": [
# "2402",
# "3149"
# ]
# }
# ]
# },
# ],
# "totals": [
# {
# "values": [
# "7212",
# "9981"
# ]
# }
# ],
# "rowCount": 16,
# "minimums": [
# {
# "values": [
# "1",
# "1"
# ]
# }
# ],
# "maximums": [
# {
# "values": [
# "3229",
# "4660"
# ]
# }
# ],
# "isDataGolden": true
# }
# }
# ]
# }

GetGA4Report

概要

GetGA4Report は、Google Analytics4 からレポートを取得するアクションです。パラメーターを設定することで、カスタマイズされたレポートを作成することができます。レポートの対象期間は、startDate、endDate で設定します。取得したい値は、metrics で選択します。ページ別、ブラウザ別などの分析軸を設定したい場合は、dimensions で指定します。リクエストで返されるディメンションまたは指標を制限したい場合は、metricFilter または dimensionFilter で指定します。返却されるレスポンスはデフォルトで最大1000行です。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
google analytics4 からデータを取得するのに必要なプロバイダーID
ga_e7502c3b8b8147410ce2
propertyId*
数値
プロパティID
12345678
startDate*
文字列
リクエスト期間の開始日付
2023-04-01
endDate*
文字列
リクエスト期間の終了日付
2023-04-30
metrics
文字列
指標(定量化されたデータ)。カンマ区切りで10個まで指定可能。入力可能な値については こちら をご参照ください。
sessions, newUsers
dimensions
文字列
ディメンション(データの属性)。カンマ区切りで5個まで指定可能。入力可能な値については こちら をご参照ください。
date, sessionDefaultChannelGroup
metricFilter
オブジェクト
リクエストで返されるデータを制限する指標のフィルタ
※ フィルタについての説明参照
dimensionFilter
オブジェクト
リクエストで返されるデータを制限するディメンションのフィルタ
※ フィルタについての説明参照
pageSize
数値
リクエストで返されるデータの数。最大で、100,000行。
1000 (デフォルト値)

フィルタについての説明

フィルタの作成方法
metricFilter や dimensionFilter を設定することで取得するデータの値を制限することができます。以下の手順によって 公式ドキュメント からフィルタを作成してください。
  • 公式ドキュメントの「Try this method」の「Request body」から metricFilter または dimensionFilter を選択し、フィルタオブジェクトを作成する。
  • 作成したフィルタの metricFilter または dimensionFilter の内側のオブジェクトをコピーする
  • GetGA4Report アクションの metricFilter または dimensionFilter パラメータに貼り付ける
フィルタの書き方
metricFilter, dimensionFilter の書き方についての説明。 詳しくは公式ドキュメントをご参照ください。
  • 基本のフィルタ
キーに filter 、値に条件を設定します。
例)
{
"filter": {
"fieldName": "eventName",
"stringFilter": {
"value":"first_visit"
}
}
}
fieldName には metrics 名または dimension 名を指定します。 stringFilter で指定している箇所は後述のフィルタの種類をご参照ください。
  • 否定系
notExpression を使用することで、フィルタで指定された条件に一致しないデータを取得できます。
例)
{
"notExpression": {
"filter": {
"fieldName": "eventName",
"stringFilter": {
"value":"first_visit"
}
}
}
}
  • AND 条件
andGroup を使用することで、複数のフィルタ条件をすべて満たすデータを取得できます。
例)
{
"andGroup": {
"expressions": [{
"filter": {
"fieldName":"sessionDefaultChannelGroup",
"stringFilter": {
"value":"Organic Search"
}
}
},
{
"filter": {
"fieldName":"country",
"stringFilter": {
"value":"Japan"
}
}
}]
}
}
expressions は、対象となるフィルタ条件をリスト形式で記述する際に使用します。
  • OR 条件
orGroup を使用することで、フィルタ条件のいずれかが満たされる場合にデータを取得できます。
例)
{
"orGroup": {
"expressions": [{
"filter": {
"fieldName":"eventName",
"stringFilter": {
"value":"page_view"
}
}
},
{
"filter": {
"fieldName":"eventName",
"stringFilter": {
"value":"first_visit"
}
}
}]
}
}
expressions は、対象となるフィルタ条件をリスト形式で記述する際に使用します。
  • Filter の種類
StringFilter
文字列関連のフィルタ。
例)
{
"matchType": CONTAINS,
"value": organic,
"caseSensitive": false
}
matchType では文字列値と値のマッチング方法を指定します。 以下、マッチタイプの種類です。
タイプ
説明
MATCH_TYPE_UNSPECIFIED
指定なし
EXACT
文字列値と完全一致
BEGINS_WITH
文字列値で始まる
ENDS_WITH
文字列値で終わる
CONTAINS
文字列値に含まれる
FULL_REGEXP
正規表現と文字列値の完全一致
PARTIAL_REGEXP
正規表現と文字列値の部分一致。
value では文字列値を指定します。 caseSensitive では文字列値で大文字と小文字を区別するかどうかを指定します。true の場合、区別されます。
inListFilter
文字列関連のフィルタ。複数の文字列値を指定できます。
例)
{
"values": ["Japan", "China"],
"caseSensitive": false
}
values には複数の文字列値を配列形式で指定します。配列の中身は空でない必要があります。 caseSensitive では文字列値で大文字と小文字を区別するかどうかを指定します。true の場合、区別されます。
numericFilter
数値または日付の値のフィルタ。
例)
{
"operation": "GREATER_THAN_OR_EQUAL",
"value": {
"int64Value":700
}
}
operation には、数値を比較する演算子を指定します。 以下、比較演算子の種類です。
比較演算子
説明
OPERATION_UNSPECIFIED
指定なし
EQUAL
等しい
LESS_THAN
値より小さい
LESS_THAN_OR_EQUAL
値以下
GREATER_THAN
値より大きい
GREATER_THAN_OR_EQUAL
値以上
value には数値または日付を指定します。 int64Value の部分には数値のタイプを指定します。以下、数値のタイプの種類です。
タイプ
説明
int64Value
整数値
doubleValue
double 値
betweenFilter フィルタ
2 つの値のフィルタ。結果は 2 つの数値の間にあることを表します。
例)
{
"fromValue": {
"int64Value":700
},
"toValue": {
"int64Value":800
}
}
fromValue には始まりの値を指定します。中身は numericFilter の value と同様です。 toValue には終わりの値を指定します。中身は numericFilter の value と同様です。
入力例
例1)Organic を含むチャネルグループの1日ごとのセッションを取得
  • filter
{"filter":{"fieldName":"sessionDefaultChannelGroup","stringFilter":{"matchType":"CONTAINS","value":"organic","caseSensitive":false}}}
  • yaml
action>: GetGA4Report
provider: ga_*****
propertyId: 12345
startDate: '2023-03-01'
endDate: '2023-03-03'
metrics: sessions
dimensions: 'date, sessionDefaultChannelGroup'
metricFilter: ''
dimensionFilter:
filter:
fieldName: sessionDefaultChannelGroup
stringFilter:
matchType: CONTAINS
value: organic
caseSensitive: false
pageSize: 1000
private: false
meta:
display:
provider:
type: chip
label: 'Google Analytics ([email protected])'
icon: googleanalytics
例2) 日本と中国以外の国の1日ごとの新規ユーザ数を取得
  • filter
{"notExpression":{"filter":{"fieldName":"country","inListFilter":{"values":["Japan","China"],"caseSensitive":false}}}}
  • yaml
# GA4のレポートを取得
+get_g_a4_report_2:
action>: GetGA4Report
provider: ga_******
propertyId: 12345
startDate: '2023-03-01'
endDate: '2023-03-03'
metrics: newUsers
dimensions: 'date, country'
metricFilter: ''
dimensionFilter:
notExpression:
filter:
fieldName: country
inListFilter:
values:
- Japan
- China
pageSize: 1000
private: false
meta:
display:
provider:
type: chip
label: 'Google Analytics ([email protected])'
icon: googleanalytics
例3) 国が日本かつチャネルグループが Organic Search の新規ユーザー数
  • filter
{"andGroup":{"expressions":[{"filter":{"fieldName":"sessionDefaultChannelGroup","stringFilter":{"value":"Organic Search"}}},{"filter":{"fieldName":"country","stringFilter":{"value":"Japan"}}}]}}
  • yaml
action>: GetGA4Report
provider: ga_*****
propertyId: 12345
startDate: '2023-03-01'
endDate: '2023-03-01'
metrics: newUsers
dimensions: 'country, sessionDefaultChannelGroup'
metricFilter: ''
dimensionFilter:
andGroup:
expressions:
- filter:
fieldName: sessionDefaultChannelGroup
stringFilter:
value: 'Organic Search'
- filter:
fieldName: country
stringFilter:
value: Japan
pageSize: 1000
private: false
meta:
display:
provider:
type: chip
label: 'Google Analytics ([email protected])'
icon: googleanalytics
例4) イベント名が page_view または first_visit の1日ごとのイベント数を取得
  • filter
{"orGroup":{"expressions":[{"filter":{"fieldName":"eventName","stringFilter":{"value":"page_view"}}},{"filter":{"fieldName":"eventName","stringFilter":{"value":"first_visit"}}}]}}
  • yaml
action>: GetGA4Report
provider: ga_****
propertyId: 12345
startDate: '2023-03-01'
endDate: '2023-03-03'
metrics: eventCount
dimensions: eventName
metricFilter: ''
dimensionFilter:
orGroup:
expressions:
- filter:
fieldName: eventName
stringFilter:
value: page_view
- filter:
fieldName: eventName
stringFilter:
value: first_visit
pageSize: 1000
private: false
meta:
display:
provider:
type: chip
label: 'Google Analytics ([email protected])'
icon: googleanalytics

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

action>: GetGA4Report
provider: ga_******
propertyId: 12345
startDate: '2023-03-01'
endDate: '2023-03-01'
metrics: sessions
dimensions: sessionDefaultChannelGroup
metricFilter:
filter:
fieldName: sessions
numericFilter:
operation: GREATER_THAN_OR_EQUAL
value:
int64Value: 100
dimensionFilter: ''
pageSize: 1000
private: false
meta:
display:
provider:
type: chip
label: 'Google Analytics ([email protected])'
icon: googleanalytics
# => {
# "dimensionHeaders": [
# {
# "name": "sessionDefaultChannelGroup"
# }
# ],
# "metricHeaders": [
# {
# "name": "sessions",
# "type": "TYPE_INTEGER"
# }
# ],
# "rows": [
# {
# "dimensionValues": [
# {
# "value": "Organic Search"
# }
# ],
# "metricValues": [
# {
# "value": "200"
# }
# ]
# }
# ],
# "rowCount": 1,
# "metadata": {
# "currencyCode": "JPY",
# "timeZone": "Asia/Tokyo"
# },
# "kind": "analyticsData#runReport"
#}

GetGoogleAdsReport (beta)

概要

GetGoogleAdsReportアクションは、Google広告からレポートを取得するアクションです。広告キャンペーン全体の掲載結果データのレポートを取得したり、広告が表示されるきっかけとなった検索語句などに絞ってデータを取得する事が出来ます。レポートを取得する為に、Google広告アカウントの「お客様ID」が必要になります。またコネクション作成時に、クライアントセンター(MCC)アカウントで連携した場合は、クライアントセンター(MCC)アカウントの「お客様ID」を入力する必要があります。「お客様ID」は下記の場所に記載されています。 取得したいデータの指定は、「Google Ads Query Language」という形式で入力する必要があります。セクション毎に取得したいデータを設定する事で様々な組み合わせのデータが取得可能です。

Google広告アカウントの階層構造

クライアントセンター(MCC)アカウントは、主に広告代理店ユーザーが、複数のクライアントアカウントをまとめて管理する為のアカウントです。MCCアカウントはツリー構造になっており、最上位の各 MCCアカウントでは、個々のアカウントや他のMCCアカウントを管理できます。下位のMCCアカウントでも、個々のアカウントや他のMCCアカウントを管理することができます。 AUTOROでコネクションを連携する際に、社内で運用するMCCアカウントを選択した場合には、どの階層に位置するMCCアカウントであれクライアントアカウントが持つ広告情報にアクセスする為に、アクションパラメーターに「manager_id」を入力する必要があります。

パラメーター

*は、必須パラメーター
名前
概要
customer_id*
文字列
Google Adsからデータを取得するのに必要なお客様ID
123456789
manager_id
文字列
MCCアカウントでアクションを利用する場合、このパラメーターにMCCアカウントのお客様IDを入力します。MCCアカウントで利用しない場合は、空欄にしておいてください。
123456780
query*
文字列
取得したいレポートを「Google Ads Query Language」で入力します。
※使用例の入力例を参照

補足: Google Ads Query Languageパラメーターの入力フォーマット

-SELECT(必須)
取得したいデータ項目を入力してください。このパラメーターでは、Segment/Metrics/Customerなどフィールド毎に取得したいデータ項目を指定します。
設定可能な全てのフィールドから、取得したいデータを入力し全てにリクエストを送る事も可能です。
(例)
Resource fields
-campaign.name
-campaign.status
Segment fields
-ad_group.name
Metrics fields
-metrics.impressions
-FROM(必須)
SELECTで指定したデータを取得するリソースを選択します。一つのリソースしか選択する事が出来ません。
(例)
campaign
customer
ad_group
-WHERE(オプション)
条件を指定する事で取得したいデータをフィルタリングする事が可能です。複数の条件を指定する事も可能です。
(例)
segments.device = MOBILE
segments.date DURING LAST_30_DAYS
metrics.impressions > 0
-ORDER_BY(オプション)
返却されるデータの順番を、指定した条件で並び替える事が出来ます。取得したデータ毎に条件を指定し、各データ毎に表示する順番を指定する事が出来ます。
(例)
metrics.clicks ASC
metrics.impressions DESC
-LIMIT(オプション)
APIから返却されるデータの数を、数値で直接指定する事が出来ます。
(例)
LIMIT 100
-PARAMETERS(オプション)
この項目では管理しているGoogle広告のメタパラメータを指定する事が出来ます。
現在APIで使用できるメタパラメータは「include_drafts」の一つだけとなっており、デフォルトでは「False」になっています。
管理しているGoogle広告アカウントに下書き状態の広告が存在する場合、「True」に設定する事で下書き状態の広告に関するデータを取得する事が出来ます。
(例)
include_drafts=true
このアクションで使用できるパラメーターに関する詳細情報は下記のURLを参考にしてください。 https://developers.google.com/google-ads/api/docs/query/interactive-gaql-builder

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

action>: GetGoogleAdsReport
customer_id: 123456789
manager_id: 123456780
query: SELECT campaign.id, campaign.name, ad_group.id, ad_group.name, ad_group_criterion.criterion_id, ad_group_criterion.keyword.text,
ad_group_criterion.keyword.match_type, metrics.impressions, metrics.engagements, metrics.clicks, metrics.cost_micros
FROM keyword_view
# {
# "resultsList": [
# {
# "campaign": {
# "resourceName": "customers/123456789/campaigns/2037742724",
# "id": 2037742724,
# "name": "テストキャンペーン"
# },
# "adGroup": {
# "resourceName": "customers/123456789/adGroups/72421289499",
# "id": 72421289499,
# "name": "テスト広告グループ"
# },
# "adGroupCriterion": {
# "resourceName": "customers/123456789/adGroupCriteria/72421289499~12073940",
# "criterionId": 12073940,
# "keyword": {
# "text": "テスト",
# "matchType": 4
# }
# },
# "metrics": {
# "impressions": 0,
# "engagements": 0,
# "clicks": 0,
# "costMicros": 0
# }
# }
# ]
# }

GetSearchAnalytics

概要

GetSearchAnalyticsは、Google Search Consoleで管理しているプロパティの検索パフォーマンスデータを取得するアクションです。返却されるレスポンスはデフォルトで最大1-25,000行まで設定できます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
プロバイダーID
searchconsole_e7502c3b8b8147410ce2
siteUrl*
文字列
対象のURLまたはドメイン名
autoro.io
startDate*
文字列
リクエスト期間の開始日付
2019-12-01
endDate*
文字列
リクエスト期間の終了日付
2019-12-08
dimensions
配列
取得するデータの種類
['query', 'page']
filters
配列
取得するデータのフィルタ
[{"dimension":"query","operator":"contains","expression":"rpa"}]
rowLimit
整数
取得する行数。1-25,000内
20000

filters についての補足

filters を設定することで取得するデータの値を制限することができます。フィルタはリストで挿入可能ですが、dimensionFilterGroups[].filters[] の形式で入力する必要があります。 詳細は、こちらを参照してください。
● 入力例
filters 入力方法
● フィルタオブジェクトの説明
名前
概要
dimension
文字列
フィルタが適用されるデータの種類
"query"
operator
文字列
dimension と expression を比較する方法。次の中から選択。『"contains"』『"equals"』『"notContains"』『"notEquals"』
"contains"
expression
文字列
フィルタを設定したい値
"rpa"
● フィルタを複数設定したい場合
複数フィルタを設定したい場合は、フィルタオブジェクトを追加してください。
[{ "dimension": "query", "operator": "contains", "expression": "rpa"},{ "dimension": "page", "operator": "notContains", "expression": "rpa"}]

アウトプット

タイプ
概要
JSON
オブジェクト
JSONレスポンス
※使用例のアウトプット参照

使用例

action>: GetSearchAnalytics
provider: searchconsole_********************
siteUrl: 'autoro.io'
startDate: '2019-12-01'
endDate: '2019-12-08'
dimensions: ['query', 'page']
filters: [{"dimension":"query","operator':"contains","expression":"rpa"}]
rowLimit: 1000
# {
# "rows": [
# {
# "keys": [
# "ホゲ rpa",
# "https://hoge.co.jp/"
# ],
# "clicks": 10,
# "impressions": 10,
# "ctr": 0.141421356,
# "position": 1
# },
# {
# "keys": [
# "rpa ホゲ 使い方",
# "https://hoge.co.jp/"
# ],
# "clicks": 10,
# "impressions": 10,
# "ctr": 0.141421356,
# "position": 1
# },
# {
# "keys": [
# "rpa ホゲ",
# "https://hoge.co.jp/"
# ],
# "clicks": 10,
# "impressions": 10,
# "ctr": 0.141421356,
# "position": 1
# },
# .............
# ]
# }

GetFacebookAdsReport

概要

GetFacebookAdsReportは、Facebook広告からレポートを取得するアクションです。広告アカウントIDを入力することで、そのアカウントで運用している広告レポートを取得できます。

パラメーター

*は、必須パラメーター
名前
概要
provider*
文字列
Facebook Ads からデータを取得するのに必要なプロバイダーID
fbads_****************
accountId*
文字列
アカウントID
1234567890123456
</