google_api_dfa_reporting v0.8.0 GoogleApi.DFAReporting.V34.Api.Accounts View Source

API calls for all endpoints tagged Accounts.

Link to this section Summary

Link to this section Functions

Link to this function

dfareporting_accounts_get(connection, profile_id, id, optional_params \\ [], opts \\ [])

View Source
dfareporting_accounts_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Account.t()} | {:error, Tesla.Env.t()}

Gets one account by ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Account ID.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.Account{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_accounts_list(connection, profile_id, optional_params \\ [], opts \\ [])

View Source
dfareporting_accounts_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.AccountsListResponse.t()}
  | {:error, Tesla.Env.t()}

Retrieves the list of accounts, possibly filtered. This method supports paging.

Parameters

  • connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :active (type: boolean()) - Select only active accounts. Don't set this field to select both active and non-active accounts.
    • :ids (type: list(String.t)) - Select only accounts with these IDs.
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
    • :searchString (type: String.t) - Allows searching for objects by name or ID. Wildcards () are allowed. For example, "account2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
    • :sortField (type: String.t) - Field by which to sort the list.
    • :sortOrder (type: String.t) - Order of sorted results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.AccountsListResponse{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_accounts_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])

View Source
dfareporting_accounts_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Account.t()} | {:error, Tesla.Env.t()}

Updates an existing account. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Account ID.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.DFAReporting.V34.Model.Account.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.Account{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_accounts_update(connection, profile_id, optional_params \\ [], opts \\ [])

View Source
dfareporting_accounts_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Account.t()} | {:error, Tesla.Env.t()}

Updates an existing account.

Parameters

  • connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.DFAReporting.V34.Model.Account.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V34.Model.Account{}} on success
  • {:error, info} on failure