package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> linkId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Delete a profile filter link.

  • 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 profile filter link belongs.

  • parameter webPropertyId

    Web property Id to which the profile filter link belongs.

  • parameter profileId

    Profile ID to which the filter link belongs.

  • parameter linkId

    ID of the profile filter link to delete.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> linkId:string -> GapiConversation.Session.t -> GapiAnalyticsV3Model.ProfileFilterLink.t * GapiConversation.Session.t

Returns a single profile filter link.

  • 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 profile filter link for.

  • parameter webPropertyId

    Web property Id to retrieve profile filter link for.

  • parameter profileId

    Profile ID to retrieve filter link for.

  • parameter linkId

    ID of the profile filter link.

val insert : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> GapiAnalyticsV3Model.ProfileFilterLink.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.ProfileFilterLink.t * GapiConversation.Session.t

Create a new profile filter link.

  • 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 profile filter link for.

  • parameter webPropertyId

    Web property Id to create profile filter link for.

  • parameter profileId

    Profile ID to create filter link for.

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

Lists all profile filter links for a profile.

  • 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 profile filter links 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 profile filter links for.

  • parameter webPropertyId

    Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • parameter profileId

    Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.

val patch : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> linkId:string -> GapiAnalyticsV3Model.ProfileFilterLink.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.ProfileFilterLink.t * GapiConversation.Session.t

Update an existing profile filter link. 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 profile filter link belongs.

  • parameter webPropertyId

    Web property Id to which profile filter link belongs

  • parameter profileId

    Profile ID to which filter link belongs

  • parameter linkId

    ID of the profile filter link to be updated.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> accountId:string -> webPropertyId:string -> profileId:string -> linkId:string -> GapiAnalyticsV3Model.ProfileFilterLink.t -> GapiConversation.Session.t -> GapiAnalyticsV3Model.ProfileFilterLink.t * GapiConversation.Session.t

Update an existing profile filter link.

  • 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 profile filter link belongs.

  • parameter webPropertyId

    Web property Id to which profile filter link belongs

  • parameter profileId

    Profile ID to which filter link belongs

  • parameter linkId

    ID of the profile filter link to be updated.