Memerlukan otorisasi
Buat filter baru. Coba sekarang atau lihat contoh.
Permintaan
Permintaan HTTP
POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
accountId |
string |
ID akun yang akan dibuatkan filter. |
Otorisasi
Permintaan ini memerlukan otorisasi dengan cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).
Cakupan |
---|
https://www.googleapis.com/auth/analytics.edit |
Isi permintaan
Dalam isi permintaan, sediakan resource management.filter dengan properti berikut:
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
Properti yang Diperlukan | |||
name |
string |
Nama filter ini. | dapat ditulis |
type |
string |
Jenis filter ini. Nilai yang memungkinkan adalah INCLUDE, exclusion, LOWERCASE, HURUF BESAR, SEARCH_AND_REPLACE, dan ADVANCED. | dapat ditulis |
Properti Opsional | |||
advancedDetails.caseSensitive |
boolean |
Menunjukkan apakah ekspresi filter peka huruf besar/kecil. | dapat ditulis |
advancedDetails.extractA |
string |
Ekspresi untuk diekstrak dari kolom A. | dapat ditulis |
advancedDetails.extractB |
string |
Ekspresi yang akan diekstrak dari kolom B. | dapat ditulis |
advancedDetails.fieldA |
string |
Kolom A | dapat ditulis |
advancedDetails.fieldAIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
advancedDetails.fieldARequired |
boolean |
Menunjukkan apakah kolom A wajib diisi agar cocok. | dapat ditulis |
advancedDetails.fieldB |
string |
Kolom B. | dapat ditulis |
advancedDetails.fieldBIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
advancedDetails.fieldBRequired |
boolean |
Menunjukkan apakah kolom B harus cocok. | dapat ditulis |
advancedDetails.outputConstructor |
string |
Ekspresi yang digunakan untuk membuat nilai output. | dapat ditulis |
advancedDetails.outputToField |
string |
Kolom output. | dapat ditulis |
advancedDetails.outputToFieldIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
advancedDetails.overrideOutputField |
boolean |
Menunjukkan apakah nilai kolom output yang ada, jika ada, harus diganti oleh ekspresi output. | dapat ditulis |
excludeDetails.caseSensitive |
boolean |
Menentukan apakah filter peka huruf besar atau kecil. | dapat ditulis |
excludeDetails.expressionValue |
string |
Filter nilai ekspresi | dapat ditulis |
excludeDetails.field |
string |
Kolom untuk memfilter. Nilai yang memungkinkan:
|
dapat ditulis |
excludeDetails.fieldIndex |
integer |
Indeks dimensi kustom. Tetapkan hanya jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
excludeDetails.matchType |
string |
Jenis pencocokan untuk filter ini. Nilai yang mungkin adalah BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS , atau MATCHES . Filter GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI , atau PAGE_HOSTNAME dapat menggunakan jenis pencocokan apa pun; semua filter lainnya harus menggunakan MATCHES . |
dapat ditulis |
includeDetails.caseSensitive |
boolean |
Menentukan apakah filter peka huruf besar atau kecil. | dapat ditulis |
includeDetails.expressionValue |
string |
Filter nilai ekspresi | dapat ditulis |
includeDetails.field |
string |
Kolom untuk memfilter. Nilai yang memungkinkan:
|
dapat ditulis |
includeDetails.fieldIndex |
integer |
Indeks dimensi kustom. Tetapkan hanya jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
includeDetails.matchType |
string |
Jenis pencocokan untuk filter ini. Nilai yang mungkin adalah BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS , atau MATCHES . Filter GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI , atau PAGE_HOSTNAME dapat menggunakan jenis pencocokan apa pun; semua filter lainnya harus menggunakan MATCHES . |
dapat ditulis |
lowercaseDetails.field |
string |
Kolom yang akan digunakan dalam filter. | dapat ditulis |
lowercaseDetails.fieldIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
searchAndReplaceDetails.caseSensitive |
boolean |
Menentukan apakah filter peka huruf besar atau kecil. | dapat ditulis |
searchAndReplaceDetails.field |
string |
Kolom yang akan digunakan dalam filter. | dapat ditulis |
searchAndReplaceDetails.fieldIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
searchAndReplaceDetails.replaceString |
string |
Istilah untuk menggantikan istilah penelusuran dengan. | dapat ditulis |
searchAndReplaceDetails.searchString |
string |
Istilah untuk ditelusuri. | dapat ditulis |
uppercaseDetails.field |
string |
Kolom yang akan digunakan dalam filter. | dapat ditulis |
uppercaseDetails.fieldIndex |
integer |
Indeks dimensi kustom. Wajib jika kolom adalah CUSTOM_DIMENSION. | dapat ditulis |
Tanggapan
Jika berhasil, metode ini menampilkan resource management.filter di isi respons.
Contoh
Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).
Java
Menggunakan library klien 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
Menggunakan library klien 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
Menggunakan library klien 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
Menggunakan library klien 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. }); }
Cobalah!
Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat responsnya. Atau, coba Penjelajah mandiri.