google_api_partners

v0.1.0

google_api_partners v0.1.0 GoogleApi.Partners.V2.Api.Analytics View Source

API calls for all endpoints tagged Analytics.

Link to this section Summary

Functions

partners_analytics_list(connection, opts \\ [])

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user

Link to this section Functions

Link to this function partners_analytics_list(connection, opts \\ []) View Source 
partners_analytics_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.ListAnalyticsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists analytics data for a user's associated company. Should only be called within the context of an authorized logged in user.

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :requestMetadata.locale (String.t): Locale to use for the current request.
    • :requestMetadata.userOverrides.ipAddress (String.t): IP address to use instead of the user's geo-located IP address.
    • :requestMetadata.experimentIds ([String.t]): Experiment IDs the current request belongs to.
    • :requestMetadata.trafficSource.trafficSubId (String.t): Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
    • :requestMetadata.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
    • :requestMetadata.partnersSessionId (String.t): Google Partners session ID.
    • :pageToken (String.t): A token identifying a page of results that the server returns. Typically, this is the value of `ListAnalyticsResponse.next_page_token` returned from the previous call to ListAnalytics. Will be a date string in `YYYY-MM-DD` format representing the end date of the date range of results to return. If unspecified or set to "", default value is the current date.
    • :pageSize (integer()): Requested page size. Server may return fewer analytics than requested. If unspecified or set to 0, default value is 30. Specifies the number of days in the date range when querying analytics. The `page_token` represents the end date of the date range and the start date is calculated using the `page_size` as the number of days BEFORE the end date. Must be a non-negative integer.
    • :requestMetadata.trafficSource.trafficSourceId (String.t): Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Returns

{:ok, %GoogleApi.Partners.V2.Model.ListAnalyticsResponse{}} on success {:error, info} on failure