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

Removes a user from the given view (profile).

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

  • parameter webPropertyId

    Web Property ID to delete the user link for.

  • parameter profileId

    View (Profile) ID to delete the user link for.

  • parameter linkId

    Link ID to delete the user link for.

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

Adds a new user to the given view (profile).

  • 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 the user link for.

  • parameter webPropertyId

    Web Property ID to create the user link for.

  • parameter profileId

    View (Profile) ID to create the user 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.EntityUserLinks.t * GapiConversation.Session.t

Lists profile-user links for a given view (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-user links to include in this response.

  • parameter start_index

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

  • parameter accountId

    Account ID which the given view (profile) belongs to.

  • parameter webPropertyId

    Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • parameter profileId

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

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

Updates permissions for an existing user on the given view (profile).

  • 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 update the user link for.

  • parameter webPropertyId

    Web Property ID to update the user link for.

  • parameter profileId

    View (Profile ID) to update the user link for.

  • parameter linkId

    Link ID to update the user link for.