google_api_ad_exchange_seller v0.1.0 GoogleApi.AdExchangeSeller.V20.Api.Accounts View Source

API calls for all endpoints tagged Accounts.

Link to this section Summary

Functions

List all custom channels in the specified ad client for this Ad Exchange account

Get information about the selected Ad Exchange account

List all accounts available to this Ad Exchange account

List the metadata for the dimensions available to this AdExchange account

List the metadata for the metrics available to this AdExchange account

Get information about the selected Ad Exchange Preferred Deal

List the preferred deals for this Ad Exchange account

Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter

Generate an Ad Exchange report based on the saved report ID sent in the query parameters

List all URL channels in the specified ad client for this Ad Exchange account

Link to this section Functions

Link to this function adexchangeseller_accounts_adclients_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_adclients_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.AdClients.t()}
  | {:error, Tesla.Env.t()}

List all ad clients in this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account to which the ad client belongs.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of ad clients to include in the response, used for paging.
    • :pageToken (String.t): A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.AdClients{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_alerts_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_alerts_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Alerts.t()}
  | {:error, Tesla.Env.t()}

List the alerts for this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account owning the alerts.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :locale (String.t): The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Alerts{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_customchannels_get(connection, account_id, ad_client_id, custom_channel_id, opts \\ []) View Source
adexchangeseller_accounts_customchannels_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.CustomChannel.t()}
  | {:error, Tesla.Env.t()}

Get the specified custom channel from the specified ad client.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account to which the ad client belongs.
  • ad_client_id (String.t): Ad client which contains the custom channel.
  • custom_channel_id (String.t): Custom channel to retrieve.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.CustomChannel{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_customchannels_list(connection, account_id, ad_client_id, opts \\ []) View Source
adexchangeseller_accounts_customchannels_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.CustomChannels.t()}
  | {:error, Tesla.Env.t()}

List all custom channels in the specified ad client for this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account to which the ad client belongs.
  • ad_client_id (String.t): Ad client for which to list custom channels.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of custom channels to include in the response, used for paging.
    • :pageToken (String.t): A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.CustomChannels{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_get(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Account.t()}
  | {:error, Tesla.Env.t()}

Get information about the selected Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account to get information about. Tip: 'myaccount' is a valid ID.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Account{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_list(connection, opts \\ []) View Source
adexchangeseller_accounts_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Accounts.t()}
  | {:error, Tesla.Env.t()}

List all accounts available to this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of accounts to include in the response, used for paging.
    • :pageToken (String.t): A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Accounts{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_metadata_dimensions_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_metadata_dimensions_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Metadata.t()}
  | {:error, Tesla.Env.t()}

List the metadata for the dimensions available to this AdExchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account with visibility to the dimensions.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Metadata{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_metadata_metrics_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_metadata_metrics_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Metadata.t()}
  | {:error, Tesla.Env.t()}

List the metadata for the metrics available to this AdExchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account with visibility to the metrics.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Metadata{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_preferreddeals_get(connection, account_id, deal_id, opts \\ []) View Source
adexchangeseller_accounts_preferreddeals_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.PreferredDeal.t()}
  | {:error, Tesla.Env.t()}

Get information about the selected Ad Exchange Preferred Deal.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account owning the deal.
  • deal_id (String.t): Preferred deal to get information about.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.PreferredDeal{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_preferreddeals_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_preferreddeals_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.PreferredDeals.t()}
  | {:error, Tesla.Env.t()}

List the preferred deals for this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account owning the deals.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.PreferredDeals{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_reports_generate(connection, account_id, start_date, end_date, opts \\ []) View Source
adexchangeseller_accounts_reports_generate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Report.t()}
  | {:error, Tesla.Env.t()}

Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account which owns the generated report.
  • start_date (String.t): Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
  • end_date (String.t): End of the date range to report on in "YYYY-MM-DD" format, inclusive.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :dimension ([String.t]): Dimensions to base the report on.
    • :filter ([String.t]): Filters to be run on the report.
    • :locale (String.t): Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
    • :maxResults (integer()): The maximum number of rows of report data to return.
    • :metric ([String.t]): Numeric columns to include in the report.
    • :sort ([String.t]): The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
    • :startIndex (integer()): Index of the first row of report data to return.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Report{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_reports_saved_generate(connection, account_id, saved_report_id, opts \\ []) View Source
adexchangeseller_accounts_reports_saved_generate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.Report.t()}
  | {:error, Tesla.Env.t()}

Generate an Ad Exchange report based on the saved report ID sent in the query parameters.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account owning the saved report.
  • saved_report_id (String.t): The saved report to retrieve.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :locale (String.t): Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
    • :maxResults (integer()): The maximum number of rows of report data to return.
    • :startIndex (integer()): Index of the first row of report data to return.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.Report{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_reports_saved_list(connection, account_id, opts \\ []) View Source
adexchangeseller_accounts_reports_saved_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.SavedReports.t()}
  | {:error, Tesla.Env.t()}

List all saved reports in this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account owning the saved reports.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of saved reports to include in the response, used for paging.
    • :pageToken (String.t): A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.SavedReports{}} on success {:error, info} on failure

Link to this function adexchangeseller_accounts_urlchannels_list(connection, account_id, ad_client_id, opts \\ []) View Source
adexchangeseller_accounts_urlchannels_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeSeller.V20.Model.UrlChannels.t()}
  | {:error, Tesla.Env.t()}

List all URL channels in the specified ad client for this Ad Exchange account.

Parameters

  • connection (GoogleApi.AdExchangeSeller.V20.Connection): Connection to server
  • account_id (String.t): Account to which the ad client belongs.
  • ad_client_id (String.t): Ad client for which to list URL channels.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :maxResults (integer()): The maximum number of URL channels to include in the response, used for paging.
    • :pageToken (String.t): A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

Returns

{:ok, %GoogleApi.AdExchangeSeller.V20.Model.UrlChannels{}} on success {:error, info} on failure