Tweet about this on TwitterShare on FacebookGoogle+

アカウントマネジメントAPI

アカウントAPIは、あなたのアカウントの基本情報を返します。現時点では、Sitesメソッドが利用可能です。

利用可能サイトメソッド

あなたのアカウントで利用可能なサイトのリストを取得するためのメソッドです。site global keysやconersion eventなどの重要なメタデータとともに返します。

リクエスト

  • URL: https://app.ginzametrics.com/api/v3/account/sites
  • HTTP Method: GET

必須パラメータ

  • api_key — APIキー

任意パラメータ

ありません。

リクエスト例

curl https://app.ginzametrics.com/api/v3/account/sites \
-d api_key=API_KEY

レスポンス

あなたのアカウントが持っている全サイトの情報をarrayで返します。以下のオプションを返します。

site_global_key サイトの識別子(ID)です。他のAPIでサイト情報を送信するために使います。
account_global_key サイトが紐付いているアカウントのIDです。
account_name サイトが紐付いているアカウントの名称です。
domain サイトのドメインです。
title サイトのタイトルです。
search_engine_global_keys このサイトでトラッキングされている検索エンジンのIDです。これらのIDは他のAPIで検索エンジンを特定する時に使います。
keyword_groups サイト内のキーワードグループに関する値をarrayで返します。内容は以下:
name キーワードグループの名前
global_key 他のAPIでキーワードグループを参照する時に使うID
conversion_events サイト内でトラッキングされているコンバージョンイベントに関する値をarrayで返します。内容は以下:
name コンバージョンイベントの名前
global_key 他のAPIでコンバージョンイベントを参照する時に使うID
active_keywords_count サイト内のアクティブなキーワード数です。

レスポンス例

[
    {
        "site_global_key": "GLOBAL_KEY_1",
        "account_global_key": "ACCOUNT_GLOBAL_KEY",
        "account_name": "Ginzamarkets, Inc.",
        "domain": "ginzametrics.jp",
        "title": "ginzametrics.jp",
        "search_engine_global_keys": [],
        "keyword_groups": [
            {
                "name": "ginzametrics",
                "global_key": "KEYGROUP_GLOBAL_KEY_1"
            },
            {
                "name": "seoとppc",
                "global_key": "KEYGROUP_GLOBAL_KEY_2"
            },
            {
                "name": "google:SSL",
                "global_key": "KEYGROUP_GLOBAL_KEY_3"
            }
        ],
        "conversion_events": [
            {
                "conversion_def": {
                    "account_id": 6,
                    "conversion_type": "goal",
                    "created_at": "2011-11-22T20:38:45Z",
                    "event_alias": "個人情報登録",
                    "goal_number": 1,
                    "id": 8213,
                    "name": "goal_1",
                    "site_id": 1168,
                    "updated_at": "2011-11-22T20:38:45Z"
                }
            },
            {
                "conversion_def": {
                    "account_id": 6,
                    "conversion_type": "goal",
                    "created_at": "2011-11-22T20:38:45Z",
                    "event_alias": "料金プラン",
                    "goal_number": 6,
                    "id": 8214,
                    "name": "goal_6",
                    "site_id": 1168,
                    "updated_at": "2011-11-22T20:38:45Z"
                }
            }
        ],
        "active_keywords_count": 467
    },
    {
        "site_global_key": "GLOBAL_KEY_2",
        "account_global_key": "ACCOUNT_GLOBAL_KEY",
        "account_name": "Ginzamarkets, Inc.",
        "domain": "ginzametrics.co.jp",
        "title": "ginzametrics.co.jp",
        "search_engine_global_keys": [],
        "keyword_groups": [
            {
                "name": "[Branded]",
                "global_key": "KEYGROUP_GLOBAL_KEY_4"
            },
            {
                "name": "カテゴリ名",
                "global_key": "KEYGROUP_GLOBAL_KEY_5"
            }
        ],
        "conversion_events": [],
        "active_keywords_count": 180
    },
]
Tweet about this on TwitterShare on FacebookGoogle+