フィルタ: insert

承認が必要です

新しいフィルタを作成します。こちらから今すぐお試しいただけます。または、例をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters

パラメータ

パラメータ名	値	説明
パスパラメータ
`accountId`	`string`	フィルタを作成するアカウント ID。

承認

このリクエストには、次のスコープの承認が必要です（詳細については、認証と承認に関する記事をご覧ください）。

スコープ
`https://www.googleapis.com/auth/analytics.edit`

リクエスト本文

リクエストの本文では、次のプロパティで management.filter リソースを指定します。

プロパティ名	値	説明	備考
必須プロパティ
`name`	`string`	このフィルタの名前。	書き込み可能
`type`	`string`	このフィルタのタイプ。有効な値は INCLUDE、EXCLUDE、LOWERCASE、UPPERCASE、SEARCH_AND_REPLACE、ADVANCED です。	書き込み可能
省略可能なプロパティ
`advancedDetails.caseSensitive`	`boolean`	フィルタの表記で大文字と小文字を区別するかどうかを指定します。	書き込み可能
`advancedDetails.extractA`	`string`	フィールド A から引用する式。	書き込み可能
`advancedDetails.extractB`	`string`	フィールド B から引用する式。	書き込み可能
`advancedDetails.fieldA`	`string`	フィールド A。	書き込み可能
`advancedDetails.fieldAIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能
`advancedDetails.fieldARequired`	`boolean`	フィールド A の一致が必要かどうかを示します。	書き込み可能
`advancedDetails.fieldB`	`string`	フィールド B。	書き込み可能
`advancedDetails.fieldBIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能
`advancedDetails.fieldBRequired`	`boolean`	フィールド B の一致が必要かどうかを示します。	書き込み可能
`advancedDetails.outputConstructor`	`string`	出力値の構成に使用する式。	書き込み可能
`advancedDetails.outputToField`	`string`	出力フィールド。	書き込み可能
`advancedDetails.outputToFieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能
`advancedDetails.overrideOutputField`	`boolean`	出力フィールドの既存の値がある場合に、出力式によって上書きするかどうかを示します。	書き込み可能
`excludeDetails.caseSensitive`	`boolean`	フィルタで大文字と小文字を区別するかどうかを指定します。	書き込み可能
`excludeDetails.expressionValue`	`string`	フィルタ式の値。	書き込み可能
`excludeDetails.field`	`string`	フィルタにより除外するフィールド。有効な値は次のとおりです。コンテンツとトラフィック PAGE_REQUEST_URI PAGE_HOSTNAME PAGE_TITLE REFERRAL COST_DATA_URI（キャンペーンのターゲット URL） HIT_TYPE INTERNAL_SEARCH_TERM INTERNAL_SEARCH_TYPE SOURCE_PROPERTY_TRACKING_ID キャンペーン、広告グループ CAMPAIGN_SOURCE CAMPAIGN_MEDIUM CAMPAIGN_NAME CAMPAIGN_AD_GROUP CAMPAIGN_TERM CAMPAIGN_CONTENT CAMPAIGN_CODE CAMPAIGN_REFERRAL_PATH e コマース TRANSACTION_COUNTRY TRANSACTION_REGION TRANSACTION_CITY TRANSACTION_AFFILIATION（ショップまたは注文の地域） ITEM_NAME ITEM_CODE ITEM_VARIATION TRANSACTION_ID TRANSACTION_CURRENCY_CODE PRODUCT_ACTION_TYPE ユーザー層 / ユーザー BROWSER BROWSER_VERSION BROWSER_SIZE PLATFORM PLATFORM_VERSION LANGUAGE SCREEN_RESOLUTION SCREEN_COLORS JAVA_ENABLED（ブール値フィールド） FLASH_VERSION GEO_SPEED（接続速度） VISITOR_TYPE GEO_ORGANIZATION（ISP 組織） GEO_DOMAIN GEO_IP_ADDRESS GEO_IP_VERSION 場所 GEO_COUNTRY GEO_REGION GEO_CITY イベント EVENT_CATEGORY EVENT_ACTION EVENT_LABEL その他 CUSTOM_FIELD_1 CUSTOM_FIELD_2 USER_DEFINED_VALUE アプリケーション APP_ID APP_INSTALLER_ID APP_NAME APP_VERSION SCREEN IS_APP（ブール値フィールド） IS_FATAL_EXCEPTION（ブール値フィールド） EXCEPTION_DESCRIPTION モバイル端末 IS_MOBILE（ブール値フィールド、サポート終了。DEVICE_CATEGORY=mobile を使用） IS_TABLET（ブール値フィールド、サポート終了。DEVICE_CATEGORY=tablet を使用） DEVICE_CATEGORY MOBILE_HAS_QWERTY_KEYBOARD（ブール値フィールド） MOBILE_HAS_NFC_SUPPORT（ブール値フィールド） MOBILE_HAS_CELLULAR_RADIO（ブール値フィールド） MOBILE_HAS_WIFI_SUPPORT（ブール値フィールド） MOBILE_BRAND_NAME MOBILE_MODEL_NAME MOBILE_MARKETING_NAME MOBILE_POINTING_METHOD ソーシャル SOCIAL_NETWORK SOCIAL_ACTION SOCIAL_ACTION_TARGET	書き込み可能
`excludeDetails.fieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合のみ設定します。	書き込み可能
`excludeDetails.matchType`	`string`	このフィルタのマッチタイプ。有効な値は `BEGINS_WITH`、`EQUAL`、`ENDS_WITH`、`CONTAINS`、`MATCHES` です。`GEO_DOMAIN`、`GEO_IP_ADDRESS`、`PAGE_REQUEST_URI`、`PAGE_HOSTNAME` フィルタでは、どのマッチタイプでも使用できます。他のフィルタでは、`MATCHES` を使用してください。	書き込み可能
`includeDetails.caseSensitive`	`boolean`	フィルタで大文字と小文字を区別するかどうかを指定します。	書き込み可能
`includeDetails.expressionValue`	`string`	フィルタ式の値。	書き込み可能
`includeDetails.field`	`string`	フィルタにより除外するフィールド。有効な値は次のとおりです。コンテンツとトラフィック PAGE_REQUEST_URI PAGE_HOSTNAME PAGE_TITLE REFERRAL COST_DATA_URI（キャンペーンのターゲット URL） HIT_TYPE INTERNAL_SEARCH_TERM INTERNAL_SEARCH_TYPE SOURCE_PROPERTY_TRACKING_ID キャンペーン、広告グループ CAMPAIGN_SOURCE CAMPAIGN_MEDIUM CAMPAIGN_NAME CAMPAIGN_AD_GROUP CAMPAIGN_TERM CAMPAIGN_CONTENT CAMPAIGN_CODE CAMPAIGN_REFERRAL_PATH e コマース TRANSACTION_COUNTRY TRANSACTION_REGION TRANSACTION_CITY TRANSACTION_AFFILIATION（ショップまたは注文の地域） ITEM_NAME ITEM_CODE ITEM_VARIATION TRANSACTION_ID TRANSACTION_CURRENCY_CODE PRODUCT_ACTION_TYPE ユーザー層 / ユーザー BROWSER BROWSER_VERSION BROWSER_SIZE PLATFORM PLATFORM_VERSION LANGUAGE SCREEN_RESOLUTION SCREEN_COLORS JAVA_ENABLED（ブール値フィールド） FLASH_VERSION GEO_SPEED（接続速度） VISITOR_TYPE GEO_ORGANIZATION（ISP 組織） GEO_DOMAIN GEO_IP_ADDRESS GEO_IP_VERSION 場所 GEO_COUNTRY GEO_REGION GEO_CITY イベント EVENT_CATEGORY EVENT_ACTION EVENT_LABEL その他 CUSTOM_FIELD_1 CUSTOM_FIELD_2 USER_DEFINED_VALUE アプリケーション APP_ID APP_INSTALLER_ID APP_NAME APP_VERSION SCREEN IS_APP（ブール値フィールド） IS_FATAL_EXCEPTION（ブール値フィールド） EXCEPTION_DESCRIPTION モバイル端末 IS_MOBILE（ブール値フィールド、サポート終了。DEVICE_CATEGORY=mobile を使用） IS_TABLET（ブール値フィールド、サポート終了。DEVICE_CATEGORY=tablet を使用） DEVICE_CATEGORY MOBILE_HAS_QWERTY_KEYBOARD（ブール値フィールド） MOBILE_HAS_NFC_SUPPORT（ブール値フィールド） MOBILE_HAS_CELLULAR_RADIO（ブール値フィールド） MOBILE_HAS_WIFI_SUPPORT（ブール値フィールド） MOBILE_BRAND_NAME MOBILE_MODEL_NAME MOBILE_MARKETING_NAME MOBILE_POINTING_METHOD ソーシャル SOCIAL_NETWORK SOCIAL_ACTION SOCIAL_ACTION_TARGET	書き込み可能
`includeDetails.fieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合のみ設定します。	書き込み可能
`includeDetails.matchType`	`string`	このフィルタのマッチタイプ。有効な値は `BEGINS_WITH`、`EQUAL`、`ENDS_WITH`、`CONTAINS`、`MATCHES` です。`GEO_DOMAIN`、`GEO_IP_ADDRESS`、`PAGE_REQUEST_URI`、`PAGE_HOSTNAME` フィルタでは、どのマッチタイプでも使用できます。他のフィルタでは、`MATCHES` を使用してください。	書き込み可能
`lowercaseDetails.field`	`string`	フィルタで使用するフィールド。	書き込み可能
`lowercaseDetails.fieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能
`searchAndReplaceDetails.caseSensitive`	`boolean`	フィルタで大文字と小文字を区別するかどうかを指定します。	書き込み可能
`searchAndReplaceDetails.field`	`string`	フィルタで使用するフィールド。	書き込み可能
`searchAndReplaceDetails.fieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能
`searchAndReplaceDetails.replaceString`	`string`	検索語句を置換する語句。	書き込み可能
`searchAndReplaceDetails.searchString`	`string`	検索語句。	書き込み可能
`uppercaseDetails.field`	`string`	フィルタで使用するフィールド。	書き込み可能
`uppercaseDetails.fieldIndex`	`integer`	カスタムディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。	書き込み可能

レスポンス

正常終了した場合、このメソッドによって management.filter リソースを含むレスポンスの本文が返されます。

例

注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません（サポートされている言語の一覧については、クライアントライブラリページをご覧ください）。

Java

Java クライアントライブラリを使用します。

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Filters Developer Guide for details.
 */

/*
 * This example creates a new filter.
 */

// Construct the filter Expression object.
AnalyticsManagementFiltersFilterExpression details = new
    AnalyticsManagementFiltersFilterExpression();
details.setField("GEO_DOMAIN");
details.setMatchType("EQUAL");
details.setExpressionValue("example.com");
details.setCaseSensitive(false);

// Construct the body of the request.
Filter body = new Filter();
body.setName("My Domain Filter");
body.setType("EXCLUDE");
body.setExcludeDetails(details);

try {
  analytics.management().filters().insert("123456", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

PHP クライアントライブラリを使用します。

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Filters Developer Guide for details.
 */

/**
 * This request creates a new filter.
 */
try {

  // Construct the filter expression object.
  $details = new Google_Service_Analytics_FilterExpression();
  $details->setField("GEO_DOMAIN");
  $details->setMatchType("EQUAL");
  $details->setExpressionValue("example.com");
  $details->setCaseSensitive(false);

  // Construct the filter and set the details.
  $filter = new Google_Service_Analytics_Filter();
  $filter->setName("My Domain Filter");
  $filter->setType("EXCLUDE");
  $filter->setExcludeDetails($details);
  $analytics->management_filters->insert('123456', $filter);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();
} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

Python クライアントライブラリを使用します。

# Note: This code assumes you have an authorized Analytics service object.
# See the Filters Developer Guide for details.

# This request creates a new filter.
try:
  analytics.management().filters().insert(
      accountId='123456',
      body={
          'name': 'My Domain Filter',
          'type': 'EXCLUDE',
          'excludeDetails': {
              'field': 'GEO_DOMAIN',
              'matchType': 'EQUAL',
              'expressionValue': 'example.com',
              'caseSensitive': False
              }
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

JavaScript クライアントライブラリを使用します。

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Filters Developer Guide for details.
 */

/*
 * This request creates a new filter.
 */
function insertFilter() {
  var request = gapi.client.analytics.management.filters.insert(
    {
      'accountId': '123456',
      'resource': {
        'name': 'My Domain Filter',
        'type': 'EXCLUDE',
        'excludeDetails': {
          'field': 'GEO_DOMAIN',
          'matchType': 'EQUAL',
          'expressionValue': 'example.com',
          'caseSensitive': false
        }
      }
    });
  request.execute(function (response) { // Handle the response. });
}

試してみる

リアルタイムのデータでこのメソッドを呼び出してレスポンスを確認するには、以下の APIs Explorer か、スタンドアロンのテストツールをご利用ください。