google_api_partners

v0.1.0

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

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

partners_users_create_company_relation(connection, user_id, opts \\ [])

Creates a user's company relation. Affiliates the user to a company

partners_users_delete_company_relation(connection, user_id, opts \\ [])

Deletes a user's company relation. Unaffiliaites the user from a company

partners_users_get(connection, user_id, opts \\ [])

Gets a user

partners_users_update_profile(connection, opts \\ [])

Updates a user's profile. A user can only update their own profile and should only be called within the context of a logged in user

Link to this section Functions

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

Creates a user's company relation. Affiliates the user to a company.

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server
  • user_id (String.t): The ID of the user. Can be set to <code>me</code> to mean the currently authenticated user.

  • 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.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.
    • :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.
    • :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.
    • :body (CompanyRelation):

Returns

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

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

Deletes a user's company relation. Unaffiliaites the user from a company.

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server
  • user_id (String.t): The ID of the user. Can be set to <code>me</code> to mean the currently authenticated user.

  • 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.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.partnersSessionId (String.t): Google Partners session ID.
    • :requestMetadata.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
    • :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.
    • :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.

Returns

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

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

Gets a user.

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server
  • user_id (String.t): Identifier of the user. Can be set to <code>me</code> to mean the currently authenticated user.

  • 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.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
    • :requestMetadata.partnersSessionId (String.t): Google Partners session ID.
    • :userView (String.t): Specifies what parts of the user information to return.
    • :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.
    • :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.

Returns

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

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

Updates a user's profile. A user can only update their own profile and should only be called within the context of a 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.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.
    • :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.
    • :body (UserProfile):

Returns

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