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

API calls for all endpoints tagged V2.

Link to this section Summary

Functions

partners_get_partnersstatus(connection, opts \\ [])

Gets Partners Status of the logged in user's agency. Should only be called if the logged in user is the admin of the agency

partners_update_companies(connection, opts \\ [])

Update company. Should only be called within the context of an authorized logged in user

partners_update_leads(connection, opts \\ [])

Updates the specified lead

Link to this section Functions

partners_get_partnersstatus(connection, opts \\ [])

partners_get_partnersstatus(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.GetPartnersStatusResponse.t()}
  | {:error, Tesla.Env.t()}

Gets Partners Status of the logged in user's agency. Should only be called if the logged in user is the admin of the agency.

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.

Returns

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

partners_update_companies(connection, opts \\ [])

partners_update_companies(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.Company.t()} | {:error, Tesla.Env.t()}

Update 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.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.
- :updateMask (String.t): Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths.
- :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.
- :body (Company):

Returns

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

partners_update_leads(connection, opts \\ [])

partners_update_leads(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.Lead.t()} | {:error, Tesla.Env.t()}

Updates the specified lead.

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.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.
- :updateMask (String.t): Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths. Only `state` and `adwords_customer_id` are currently supported.
- :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.
- :body (Lead):

Returns

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