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

API calls for all endpoints tagged ContentCategories.

Summary

Functions

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

Deletes an existing content category.

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

Gets one content category by ID.

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

Inserts a new content category.

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

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

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

Updates an existing content category. This method supports patch semantics.

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

Updates an existing content category.

Functions

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

@spec dfareporting_content_categories_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes an existing content category.

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) - Content category 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, %{}} on success
{:error, info} on failure

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

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

Gets one content category 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) - Content category 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.ContentCategory{}} on success
{:error, info} on failure

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

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

Inserts a new content category.

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.ContentCategory.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a list of content categories, 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").
- :ids (type: list(String.t)) - Select only content categories 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, "contentcategory2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 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 "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
- :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.V33.Model.ContentCategoriesListResponse{}} on success
{:error, info} on failure

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

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

Updates an existing content category. 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) - ContentCategory 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.ContentCategory.t) -
opts (type: keyword()) - Call options

Returns

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

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

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

Updates an existing content category.

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.ContentCategory.t) -
opts (type: keyword()) - Call options

Returns

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