承認が必要です
新しいフィルタを作成します。 こちらから今すぐお試しいただけます。または、例をご覧ください。
リクエスト
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 |
フィルタにより除外するフィールド。有効な値は次のとおりです。
|
書き込み可能 |
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 |
フィルタにより除外するフィールド。有効な値は次のとおりです。
|
書き込み可能 |
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 か、 スタンドアロンの テストツール をご利用ください。