package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> filterId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Filter.t * GapiConversation.Session.t

Delete a filter.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID to delete the filter for.

  • parameter filterId

    ID of the filter to be deleted.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> filterId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Filter.t * GapiConversation.Session.t

Returns a filters to which the user has access.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter etag

    Optional ETag.

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID to retrieve filters for.

  • parameter filterId

    Filter ID to retrieve filters for.

Create a new filter.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID to create filter for.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?max_results:int -> ?start_index:int -> accountId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Filters.t * GapiConversation.Session.t

Lists all filters for an account

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter max_results

    The maximum number of filters to include in this response.

  • parameter start_index

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • parameter accountId

    Account ID to retrieve filters for.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> filterId:string -> GapiAnalyticsV3Model.Filter.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Filter.t * GapiConversation.Session.t

Updates an existing filter. This method supports patch semantics.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID to which the filter belongs.

  • parameter filterId

    ID of the filter to be updated.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> filterId:string -> GapiAnalyticsV3Model.Filter.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.Filter.t * GapiConversation.Session.t

Updates an existing filter.

  • parameter base_url

    Service endpoint base URL (defaults to "https://www.googleapis.com/analytics/v3/").

  • parameter std_params

    Optional standard parameters.

  • parameter accountId

    Account ID to which the filter belongs.

  • parameter filterId

    ID of the filter to be updated.