Marketing

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

GetGA4Report

概要

GetGA4Report は、Google Analytics4 からレポートを取得するアクションです。パラメーターを設定することで、カスタマイズされたレポートを作成することができます。レポートの対象期間は、startDate、endDate で設定します。取得したい値は、metrics で選択します。ページ別、ブラウザ別などの分析軸を設定したい場合は、dimensions で指定します。リクエストで返されるディメンションまたは指標を制限したい場合は、metricFilter または dimensionFilter で指定します。返却されるレスポンスはデフォルトで最大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 では文字列値と値のマッチング方法を指定します。 以下、マッチタイプの種類です。

value では文字列値を指定します。 caseSensitive では文字列値で大文字と小文字を区別するかどうかを指定します。true の場合、区別されます。

inListFilter

文字列関連のフィルタ。複数の文字列値を指定できます。

例）
{
  "values": ["Japan", "China"],
  "caseSensitive": false
}

values には複数の文字列値を配列形式で指定します。配列の中身は空でない必要があります。 caseSensitive では文字列値で大文字と小文字を区別するかどうかを指定します。true の場合、区別されます。

numericFilter

数値または日付の値のフィルタ。

例）
{
  "operation": "GREATER_THAN_OR_EQUAL",
  "value": {
    "int64Value":700
  }
}

operation には、数値を比較する演算子を指定します。 以下、比較演算子の種類です。

value には数値または日付を指定します。 int64Value の部分には数値のタイプを指定します。以下、数値のタイプの種類です。

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 (example@example.com)'
        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 (example@example.com)'
        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 (example@example.com)'
        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 (example@example.com)'
        icon: googleanalytics

アウトプット

使用例

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 (example@example.com)'
        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」を入力する必要があります。

パラメーター

*は、必須パラメーター

補足: 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

アウトプット

使用例

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行まで設定できます。

パラメーター

*は、必須パラメーター

filters についての補足

filters を設定することで取得するデータの値を制限することができます。フィルタはリストで挿入可能ですが、dimensionFilterGroups[].filters[] の形式で入力する必要があります。 詳細は、こちらを参照してください。

● 入力例

● フィルタオブジェクトの説明

● フィルタを複数設定したい場合

複数フィルタを設定したい場合は、フィルタオブジェクトを追加してください。

[{ "dimension": "query", "operator": "contains", "expression": "rpa"},{ "dimension": "page", "operator": "notContains", "expression": "rpa"}]

アウトプット

使用例

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を入力することで、そのアカウントで運用している広告レポートを取得できます。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+get_facebook_ads_report_1:
  action>: GetFacebookAdsReport
  provider: fbads_****************
  accountId: 1234567890123456
  level: ad
  startDate: '2020-05-01'
  endDate: '2020-05-07'
  fields: 'ad_id, ad_name, reach, impressions, clicks, ctr'
  breakdowns: ''
  actionBreakdowns: ''
  actionAttributionWindows: ''
  useUnifiedAttributionSetting: false
  limit: 3000
# {
#   "data": [
#     {
#       "ad_id": "10000000000000001",
#       "ad_name": "広告A",
#       "reach": "3279",
#       "impressions": "4565",
#       "clicks": "52",
#       "ctr": "1.139102",
#       "date_start": "2020-05-01",
#       "date_stop": "2020-05-07"
#     },
#     {
#       "ad_id": "10000000000000002",
#       "ad_name": "広告B",
#       "reach": "2278",
#       "impressions": "2800",
#       "clicks": "13",
#       "ctr": "0.464286",
#       "date_start": "2020-05-01",
#       "date_stop": "2020-05-07"
#     }
#   ],
#   "paging": {
#     "cursors": {
#       "before": "MAZDZD",
#       "after": "NwZDZD"
#     },
#   }
# }

GetYahooSearchAdsReportV2

概要

GetYahooSearchAdsReportV2は、Yahoo検索広告からレポートを取得するアクションです。広告アカウントIDを入力することで、そのアカウントで運用している広告レポートを取得できます。このアクションではYahoo!広告 API V13が使用されています。

パラメーター

*は、必須パラメーター

※reportType パラメーターに BID_MODIFIER を選択した場合、startDate パラメーターと endDate パラメーターは入力不要です。

アウトプット

使用例

+get_yahoo_search_ads_report_v2_1:
  action>: GetYahooSearchAdsReportV2
  provider: yahooads_****************
  accountId: 1234567890123456
  startDate: '20200501'
  endDate: '20200507'
  reportName: 'testreport'
  reportType: AD
  fields: 'ACCOUNT_ID,AD_NAME,IMPS,CLICKS'
  reportDownloadFormat: CSV
  reportLanguage: EN
  # => "/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/yahooads/testreport.csv"

GetYahooDisplayAdsReportV2

概要

GetYahooDisplayAdsReportV2は、Yahooディスプレイ広告からレポートを取得するアクションです。広告アカウントIDを入力することで、そのアカウントで運用している広告レポートを取得できます。このアクションではYahoo!広告 API V13が使用されています。

パラメーター

*は、必須パラメーター

アウトプット

使用例

+get_yahoo_display_ads_report_v2_1:
  action>: GetYahooDisplayAdsReportV2
  provider: yahooads_****************
  accountId: 1234567890123456
  startDate: '20200801'
  endDate: '20200807'
  reportType: AD
  reportName: 'testreport'
  fields: 'ACCOUNT_ID,AD_NAME,IMPS,CLICKS'
  reportDownloadFormat: CSV
  reportLanguage: EN
  reportIncludeDeleted: true
  # => "/tmp/ac44342d-d956-4818-b3ee-e3d4990b06c8/yahooads/testreport.csv"

GetTwitterAdsReport

概要

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

パラメーター

*は、必須パラメーター

入力するパラメーターについての補足

GetTwitterAdsReportは、reportType 及び entity の入力により必要なパラメータが変化します。以下表の「○」で示されるパラメータが必要な項目です。

アウトプット

使用例

+get_twitter_ads_report_1:
  action>: GetTwitterAdsReport
  provider: twads_****************
  reportType: Analytics
  accountId: 1234567890
  startDate: '2020-08-04'
  endDate: '2020-08-14'
  entity: CAMPAIGN
  campaignId: abcde
  granularity: TOTAL
  metricGroups: ENGAGEMENT
  placement: ALL_ON_TWITTER
  returnArray: true

# [
#   [
#     "start_time",
#     "end_time",
#     "placement",
#     "granularity",
#     "entity",
#     "id",
#     "impressions",
#     "tweets_send",
#     "qualified_impressions",
#     "follows",
#     "app_clicks",
#     "retweets",
#     "unfollows",
#     "likes",
#     "engagements",
#     "clicks",
#     "card_engagements",
#     "poll_card_vote",
#     "replies",
#     "url_clicks",
#     "carousel_swipes"
#   ],
#   [
#     "2020-08-04 00:00",
#     "2020-08-15 00:00",
#     "ALL_ON_TWITTER",
#     "TOTAL",
#     "CAMPAIGN",
#     "abcde",
#     1234,
#     null,
#     null,
#     10,
#     null,
#     null,
#     null,
#     1,
#     60,
#     60,
#     null,
#     null,
#     null,
#     null,
#     null
#   ]
# ]


+get_twitter_ads_report_1:
  action>: GetTwitterAdsReport
  provider: twads_****************
  reportType: Analytics
  accountId: 1234567890
  startDate: '2020-08-04'
  endDate: '2020-08-14'
  entity: CAMPAIGN
  campaignId: abcde
  granularity: TOTAL
  metricGroups: ENGAGEMENT
  placement: ALL_ON_TWITTER
  returnArray: false

# {
#   "data_type": "stats",
#   "time_series_length": 1,
#   "data": [
#     {
#       "id": "abcde",
#       "id_data": [
#         {
#           "segment": null,
#           "metrics": {
#             "impressions": [1234],
#             "tweets_send": null,
#             "qualified_impressions": null,
#             "follows": [10],
#             "app_clicks": null,
#             "retweets": null,
#             "unfollows": null,
#             "likes": [1],
#             "engagements": [60],
#             "clicks": [60],
#             "card_engagements": null,
#             "poll_card_vote": null,
#             "replies": null,
#             "url_clicks": null,
#             "carousel_swipes": null
#           }
#         }
#       ]
#     }
#   ],
#   "request": {
#     "params": {
#       "start_time": "2020-08-03T15:00:00Z",
#       "segmentation_type": null,
#       "entity_ids": [
#         "abcde"
#       ],
#       "end_time": "2020-08-14T15:00:00Z",
#       "country": null,
#       "placement": "ALL_ON_TWITTER",
#       "granularity": "TOTAL",
#       "entity": "CAMPAIGN",
#       "platform": null,
#       "metric_groups": [
#         "ENGAGEMENT"
#       ]
#     }
#   }
# }

GetAppleSearchAdsReport

概要

GetAppleSearchAdsReportは、Apple Search Adsからレポートを取得するアクションです。アカウントで運用しているキャンペーンレポートを取得できます。レスポンスはキャンペーン単位で最大1,000行まで返却されます。

パラメーター

*は、必須パラメーター

conditions についての補足

conditions を設定することで取得するキャンペーンを制限することができます。フィルタはリストで挿入可能です。

● コンディションオブジェクトの説明

● フィルタを複数設定したい場合

複数フィルタを設定したい場合は、フィルタオブジェクトを追加してください。

[{"field":"countriesOrRegions","operator":"CONTAINS_ANY","values":["HK","JP","RU"]},{"field":"displayStatus","operator":"EQUALS","values":["RUNNING"]}]

アウトプット

GetAppleSearchAdsReport は、returnArray パラメーターの設定によって、アウトプットが変わるアクションになっています。 returnArray = true にすると、CSV加工等に利用しやすい二次元配列をアウトプットし、returnArray = false の時は、JSONをアウトプットします。

なお、二次元配列はJSONから一部を抽出したものとなっているため、情報量はJSONより少なくなります。

使用例

+get_apple_search_ads_report_1:
  action>: GetAppleSearchAdsReport
  provider: asads_****************
  campaignGroupId: 12345678
  startDate: '2020-10-27'
  endDate: '2020-10-28'
  timeInterval: DAILY
  conditions: [{"field":"campaignId","operator":"EQUALS","values":[123456789]}]
  returnArray: true

# [
#   [
#     "dateRange",
#     "timeInterval",
#     "organizationId",
#     "timeZone",
#     "currency",
#     "campaignName",
#     "campaignId",
#     "date",
#     "impressions",
#     "taps",
#     "installs",
#     "newDownloads",
#     "redownloads",
#     "latOnInstalls",
#     "latOffInstalls",
#     "ttr",
#     "avgCPA",
#     "avgCPT",
#     "localSpend",
#     "conversionRate"
#   ],
#   [
#     "2020-10-27 - 2020-10-28",
#     "LIFETIME",
#     1234567,
#     "ORTZ",
#     "JPY",
#     "sample campaign",
#     123456789,
#     "2020-10-27",
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0,
#     0
#   ],
#   [
#     "2020-10-27 - 2020-10-28",
#     "LIFETIME",
#     1234567,
#     "ORTZ",
#     "JPY",
#     "sample campaign",
#     123456789,
#     "2020-10-28",
#     50,
#     6,
#     2,
#     2,
#     0,
#     0,
#     0,
#     0.12,
#     38.5,
#     12.8333,
#     77,
#     0.3333
#   ]
# ]


+get_apple_search_ads_report_1:
  action>: GetAppleSearchAdsReport
  provider: asads_****************
  campaignGroupId: 12345678
  startDate: '2020-10-27'
  endDate: '2020-10-28'
  timeInterval: DAILY
  conditions: [{"field":"campaignId","operator":"EQUALS","values":[123456789]}]
  returnArray: false

# {
#     "data": {
#         "reportingDataResponse": {
#             "row": [
#                 {
#                     "other": false,
#                     "granularity": [
#                         {
#                             "impressions": 0,
#                             "taps": 0,
#                             "installs": 0,
#                             "newDownloads": 0,
#                             "redownloads": 0,
#                             "latOnInstalls": 0,
#                             "latOffInstalls": 0,
#                             "ttr": 0,
#                             "avgCPA": {
#                                 "amount": "0",
#                                 "currency": "JPY"
#                             },
#                             "avgCPT": {
#                                 "amount": "0",
#                                 "currency": "JPY"
#                             },
#                             "localSpend": {
#                                 "amount": "0",
#                                 "currency": "JPY"
#                             },
#                             "conversionRate": 0,
#                             "date": "2020-10-27"
#                         },
#                         {
#                             "impressions": 50,
#                             "taps": 6,
#                             "installs": 2,
#                             "newDownloads": 2,
#                             "redownloads": 0,
#                             "latOnInstalls": 0,
#                             "latOffInstalls": 0,
#                             "ttr": 0.12,
#                             "avgCPA": {
#                                 "amount": "38.5",
#                                 "currency": "JPY"
#                             },
#                             "avgCPT": {
#                                 "amount": "12.8333",
#                                 "currency": "JPY"
#                             },
#                             "localSpend": {
#                                 "amount": "77",
#                                 "currency": "JPY"
#                             },
#                             "conversionRate": 0.3333,
#                             "date": "2020-10-28"
#                         }
#                     ],
#                     "metadata": {
#                         "campaignId": 123456789,
#                         "campaignName": "sample campaign",
#                         "deleted": false,
#                         "campaignStatus": "PAUSED",
#                         "app": {
#                             "appName": "sample app",
#                             "adamId": 1234567890
#                         },
#                         "servingStatus": "NOT_RUNNING",
#                         "servingStateReasons": [
#                             "TOTAL_BUDGET_EXHAUSTED",
#                             "PAUSED_BY_USER"
#                         ],
#                         "countriesOrRegions": [
#                             "HK",
#                             "JP",
#                             "RU"
#                         ],
#                         "modificationTime": "2020-11-05T14:00:00.107",
#                         "totalBudget": {
#                             "amount": "100",
#                             "currency": "JPY"
#                         },
#                         "dailyBudget": {
#                             "amount": "50",
#                             "currency": "JPY"
#                         },
#                         "displayStatus": "PAUSED",
#                         "supplySources": [
#                             "APPSTORE_SEARCH_RESULTS"
#                         ],
#                         "adChannelType": "SEARCH",
#                         "orgId": 1234567,
#                         "countryOrRegionServingStateReasons": {}
#                     }
#                 }
#             ]
#         }
#     },
#     "pagination": {
#         "totalResults": 1,
#         "startIndex": 0,
#         "itemsPerPage": 1
#     },
#     "error": null
# }

GetTikTokAdsReportV2

概要

GetTikTokAdsReportV2 は、TikTok 広告からレポートを取得するアクションです。広告主、広告セット、キャンペーン、および広告といった様々なレベルで広告レポートを取得できます。

パラメーター

*は、必須パラメーター

入力するパラメーターについての補足

GetTikTokAdsReportV2 は、dataLevel の選択により入力可能なパラメータが変化します。以下表の「○」で示されるパラメータが入力可能な項目です。

アウトプット

使用例

+get_tik_tok_ads_report_v2_1:
  action>: GetTikTokAdsReportV2
  provider: ttads_****
  advertiserId: 'advertiser-***'
  dataLevel: Advertiser
  startDate: '2021-01-01'
  endDate: '2021-01-10'
  timeGranularity: DAILY
  metrics: 'spend, impressions'
  private: false
  meta:
    display:
      provider:
        type: chip
        label: 'TikTok Ads (testuser)'
        icon: tiktokads
      advertiserId:
        label: 'test'
        icon: tiktokads
        type: chip

# {
#   "list": [
#     {
#       "dimensions": {
#         "stat_time_day": "2021-01-06 00:00:00",
#         "advertiser_id": "********"
#       },
#       "metrics": {
#         "spend": "0.000",
#         "impressions": "0"
#       }
#     },
#     {
#       "dimensions": {
#         "stat_time_day": "2021-01-07 00:00:00",
#         "advertiser_id": "********"
#       },
#       "metrics": {
#         "spend": "864.000",
#         "impressions": "3601"
#       }
#     },
#   ],
#   "page_info": {
#     "page_size": 2,
#     "total_number": 2,
#     "page": 1,
#     "total_page": 1
#   }
# }

GetMsAdsReport

概要

GetMsAdsReport は、Microsoft 広告からレポートを取得するアクションです。配信パフォーマンス レポートを取得することができます。

パラメーター

*は、必須パラメーター

アウトプット

使用例

# Microsoft Adsのレポート取得
+get_ms_ads_report_1:
  action>: GetMsAdsReport
  provider: msads_0fa30e93d8aa4f846e81
  accountIds: 484906037
  reportType: AdPerformanceReport
  aggregation: Daily
  columns: 'AccountId,AccountName,Clicks,AdGroupName,AdGroupId,Impressions,Conversions,Spend'
  startDate: '2023-10-01'
  endDate: '2023-10-31'
  private: false
  meta:
    display:
      provider:
        type: chip
        label: 'Microsoft Ads (2023年11月20日19時37分 追加)'
        icon: msads

# Output =>
# [
#   [
#     "AccountId",
#     "AccountName",
#     "Clicks",
#     "AdGroupName",
#     "AdGroupId",
#     "Impressions",
#     "Conversions",
#     "Spend"
#   ],
#   [
#     484906037,
#     "AUTORO",
#     7,
#     "OneEachAdgroup",
#     1199567402136326,
#     10,
#     3,
#     1.43
#   ]
# ]