GoogleApi.GmailPostmasterTools.V1.Api.Domains (google_api_gmail_postmaster_tools v0.7.0)

View Source

API calls for all endpoints tagged Domains.

Summary

Functions

gmailpostmastertools_domains_get(connection, name, optional_params \\ [], opts \\ [])

Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.

gmailpostmastertools_domains_list(connection, optional_params \\ [], opts \\ [])

Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.

gmailpostmastertools_domains_traffic_stats_get(connection, name, optional_params \\ [], opts \\ [])

Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

gmailpostmastertools_domains_traffic_stats_list(connection, parent, optional_params \\ [], opts \\ [])

List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

Functions

gmailpostmastertools_domains_get(connection, name, optional_params \\ [], opts \\ [])

@spec gmailpostmastertools_domains_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.GmailPostmasterTools.V1.Model.Domain.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.

Parameters

  • connection (type: GoogleApi.GmailPostmasterTools.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the domain. It should have the form domains/{domain_name}, where domain_name is the fully qualified domain name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.GmailPostmasterTools.V1.Model.Domain{}} on success
  • {:error, info} on failure

gmailpostmastertools_domains_list(connection, optional_params \\ [], opts \\ [])

@spec gmailpostmastertools_domains_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.GmailPostmasterTools.V1.Model.ListDomainsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.

Parameters

  • connection (type: GoogleApi.GmailPostmasterTools.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to ListDomains method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.GmailPostmasterTools.V1.Model.ListDomainsResponse{}} on success
  • {:error, info} on failure

gmailpostmastertools_domains_traffic_stats_get(connection, name, optional_params \\ [], opts \\ [])

@spec gmailpostmastertools_domains_traffic_stats_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.GmailPostmasterTools.V1.Model.TrafficStats.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

Parameters

  • connection (type: GoogleApi.GmailPostmasterTools.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.GmailPostmasterTools.V1.Model.TrafficStats{}} on success
  • {:error, info} on failure

gmailpostmastertools_domains_traffic_stats_list(connection, parent, optional_params \\ [], opts \\ [])

@spec gmailpostmastertools_domains_traffic_stats_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.GmailPostmasterTools.V1.Model.ListTrafficStatsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

Parameters

  • connection (type: GoogleApi.GmailPostmasterTools.V1.Connection.t) - Connection to server
  • parent (type: String.t) - The resource name of the domain whose traffic statistics we'd like to list. It should have the form domains/{domain_name}, where domain_name is the fully qualified domain name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"endDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"endDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"endDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
    • :pageSize (type: integer()) - Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to ListTrafficStats method.
    • :"startDate.day" (type: integer()) - Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
    • :"startDate.month" (type: integer()) - Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
    • :"startDate.year" (type: integer()) - Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.GmailPostmasterTools.V1.Model.ListTrafficStatsResponse{}} on success
  • {:error, info} on failure