Erstellen Sie einen neuen Filter. Jetzt ausprobieren oder Beispiel ansehen
Anfragen
HTTP-Anfrage
POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters
Parameter
Parametername | Wert | Beschreibung |
---|---|---|
Pfadparameter | ||
accountId |
string |
Die Konto-ID, für die ein Filter erstellt werden soll. |
Autorisierung
Für diese Anfrage ist eine Autorisierung in folgendem Bereich erforderlich. Weitere Informationen zur Authentifizierung und Autorisierung
Umfang |
---|
https://www.googleapis.com/auth/analytics.edit |
Anfragetext
Geben Sie im Anfragetext eine management.filter-Ressource mit den folgenden Properties an:
Attributname | Wert | Beschreibung | Hinweise |
---|---|---|---|
Erforderliche Properties | |||
name |
string |
Name dieses Filters. | Bearbeitbar |
type |
string |
Typ dieses Filters. Mögliche Werte sind: INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE und ADVANCED. | Bearbeitbar |
Optionale Attribute | |||
advancedDetails.caseSensitive |
boolean |
Gibt an, ob bei den Filterausdrücken zwischen Groß- und Kleinschreibung unterschieden wird. | Bearbeitbar |
advancedDetails.extractA |
string |
Ausdruck, der aus Feld A extrahiert werden soll. | Bearbeitbar |
advancedDetails.extractB |
string |
Ausdruck, der aus Feld B extrahiert werden soll. | Bearbeitbar |
advancedDetails.fieldA |
string |
Feld A. | Bearbeitbar |
advancedDetails.fieldAIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
advancedDetails.fieldARequired |
boolean |
Gibt an, ob Feld A übereinstimmen muss. | Bearbeitbar |
advancedDetails.fieldB |
string |
Feld B. | Bearbeitbar |
advancedDetails.fieldBIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
advancedDetails.fieldBRequired |
boolean |
Gibt an, ob Feld B übereinstimmen muss. | Bearbeitbar |
advancedDetails.outputConstructor |
string |
Ausdruck, der zum Erstellen des Ausgabewerts verwendet wird. | Bearbeitbar |
advancedDetails.outputToField |
string |
Ausgabefeld. | Bearbeitbar |
advancedDetails.outputToFieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
advancedDetails.overrideOutputField |
boolean |
Gibt an, ob der vorhandene Wert des Ausgabefelds, falls vorhanden, durch den Ausgabeausdruck überschrieben werden soll. | Bearbeitbar |
excludeDetails.caseSensitive |
boolean |
Legt fest, ob beim Filter zwischen Groß- und Kleinschreibung unterschieden wird. | Bearbeitbar |
excludeDetails.expressionValue |
string |
Filterausdruck | Bearbeitbar |
excludeDetails.field |
string |
Zu filterndes Feld. Mögliche Werte:
|
Bearbeitbar |
excludeDetails.fieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Wird nur festgelegt, wenn das Feld den Wert CUSTOM_DIMENSION hat. | Bearbeitbar |
excludeDetails.matchType |
string |
Keyword-Option für diesen Filter. Mögliche Werte sind BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS oder MATCHES . Für Filter vom Typ GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI oder PAGE_HOSTNAME kann eine beliebige Keyword-Option verwendet werden. Für alle anderen Filter muss MATCHES verwendet werden. |
Bearbeitbar |
includeDetails.caseSensitive |
boolean |
Legt fest, ob beim Filter zwischen Groß- und Kleinschreibung unterschieden wird. | Bearbeitbar |
includeDetails.expressionValue |
string |
Filterausdruck | Bearbeitbar |
includeDetails.field |
string |
Zu filterndes Feld. Mögliche Werte:
|
Bearbeitbar |
includeDetails.fieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Wird nur festgelegt, wenn das Feld den Wert CUSTOM_DIMENSION hat. | Bearbeitbar |
includeDetails.matchType |
string |
Keyword-Option für diesen Filter. Mögliche Werte sind BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS oder MATCHES . Für Filter vom Typ GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI oder PAGE_HOSTNAME kann eine beliebige Keyword-Option verwendet werden. Für alle anderen Filter muss MATCHES verwendet werden. |
Bearbeitbar |
lowercaseDetails.field |
string |
Feld, das im Filter verwendet werden soll. | Bearbeitbar |
lowercaseDetails.fieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
searchAndReplaceDetails.caseSensitive |
boolean |
Legt fest, ob beim Filter zwischen Groß- und Kleinschreibung unterschieden wird. | Bearbeitbar |
searchAndReplaceDetails.field |
string |
Feld, das im Filter verwendet werden soll. | Bearbeitbar |
searchAndReplaceDetails.fieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
searchAndReplaceDetails.replaceString |
string |
Begriff, durch den der Suchbegriff ersetzt werden soll. | Bearbeitbar |
searchAndReplaceDetails.searchString |
string |
Suchbegriff. | Bearbeitbar |
uppercaseDetails.field |
string |
Feld, das im Filter verwendet werden soll. | Bearbeitbar |
uppercaseDetails.fieldIndex |
integer |
Der Index der benutzerdefinierten Dimension. Pflichtfeld, wenn das Feld CUSTOM_DIMENSION ist. | Bearbeitbar |
Antwort
Wenn der Vorgang erfolgreich ist, wird mit dieser Methode eine management.filter-Ressource im Antworttext zurückgegeben.
Beispiele
Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.
Java
Verwendet die Java-Clientbibliothek.
/* * 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
Die PHP-Clientbibliothek wird verwendet.
/** * 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
Verwendet die Python-Clientbibliothek.
# 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
Verwendet die JavaScript-Clientbibliothek.
/* * 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. }); }
Testen!
Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Alternativ können Sie den eigenständigen Explorer ausprobieren.