GoogleApi.DFAReporting.V33.Api.Sites (google_api_dfa_reporting v0.31.0)

View Source

API calls for all endpoints tagged Sites.

Summary

Functions

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

Gets one site by ID.

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

Inserts a new site.

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

Retrieves a list of sites, possibly filtered. This method supports paging.

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

Updates an existing site. This method supports patch semantics.

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

Updates an existing site.

Functions

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

@spec dfareporting_sites_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one site by ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Site ID.
  • 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.DFAReporting.V33.Model.Site{}} on success
  • {:error, info} on failure

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

@spec dfareporting_sites_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new site.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • 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").
    • :body (type: GoogleApi.DFAReporting.V33.Model.Site.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec dfareporting_sites_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.SitesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of sites, possibly filtered. This method supports paging.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • 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").
    • :acceptsInStreamVideoPlacements (type: boolean()) - This search filter is no longer supported and will have no effect on the results returned.
    • :acceptsInterstitialPlacements (type: boolean()) - This search filter is no longer supported and will have no effect on the results returned.
    • :acceptsPublisherPaidPlacements (type: boolean()) - Select only sites that accept publisher paid placements.
    • :adWordsSite (type: boolean()) - Select only AdWords sites.
    • :approved (type: boolean()) - Select only approved sites.
    • :campaignIds (type: list(String.t)) - Select only sites with these campaign IDs.
    • :directorySiteIds (type: list(String.t)) - Select only sites with these directory site IDs.
    • :ids (type: list(String.t)) - Select only sites 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, ID or keyName. Wildcards () are allowed. For example, "site2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 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 "site" will match objects with name "my site", "site 2015", or simply "site".
    • :sortField (type: String.t) - Field by which to sort the list.
    • :sortOrder (type: String.t) - Order of sorted results.
    • :subaccountId (type: String.t) - Select only sites with this subaccount ID.
    • :unmappedSite (type: boolean()) - Select only sites that have not been mapped to a directory site.
  • opts (type: keyword()) - Call options

Returns

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

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

@spec dfareporting_sites_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing site. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Site ID.
  • 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").
    • :body (type: GoogleApi.DFAReporting.V33.Model.Site.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec dfareporting_sites_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Site.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing site.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • 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").
    • :body (type: GoogleApi.DFAReporting.V33.Model.Site.t) -
  • opts (type: keyword()) - Call options

Returns

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