google_api_ad_experience_report v0.15.0 GoogleApi.AdExperienceReport.V1.Api.Sites View Source

API calls for all endpoints tagged Sites.

Link to this section Summary

Link to this section Functions

Link to this function

adexperiencereport_sites_get(connection, sites_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexperiencereport_sites_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExperienceReport.V1.Model.SiteSummaryResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a site's Ad Experience Report summary.

Parameters

  • connection (type: GoogleApi.AdExperienceReport.V1.Connection.t) - Connection to server

  • sites_id (type: String.t) - Part of name. Required. The name of the site whose summary to get, e.g. sites/http%3A%2F%2Fwww.google.com%2F.

    Format: sites/{site}

  • 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.AdExperienceReport.V1.Model.SiteSummaryResponse{}} on success
  • {:error, info} on failure