google_api_ad_sense_host v0.2.0 GoogleApi.AdSenseHost.V41.Api.Customchannels View Source

API calls for all endpoints tagged Customchannels.

Link to this section Summary

Link to this section Functions

Link to this function

adsensehost_customchannels_delete(connection, ad_client_id, custom_channel_id, optional_params \\ [], opts \\ []) View Source

Delete a specific custom channel from the host AdSense account.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client from which to delete the custom channel.
  • custom_channel_id (String.t): Custom channel to delete.
  • optional_params (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.AdSenseHost.V41.Model.CustomChannel{}} on success {:error, info} on failure

Link to this function

adsensehost_customchannels_get(connection, ad_client_id, custom_channel_id, optional_params \\ [], opts \\ []) View Source

Get a specific custom channel from the host AdSense account.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client from which to get the custom channel.
  • custom_channel_id (String.t): Custom channel to get.
  • optional_params (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.AdSenseHost.V41.Model.CustomChannel{}} on success {:error, info} on failure

Link to this function

adsensehost_customchannels_insert(connection, ad_client_id, optional_params \\ [], opts \\ []) View Source

Add a new custom channel to the host AdSense account.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client to which the new custom channel will be added.
  • optional_params (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.
    • :body (CustomChannel):

Returns

{:ok, %GoogleApi.AdSenseHost.V41.Model.CustomChannel{}} on success {:error, info} on failure

Link to this function

adsensehost_customchannels_list(connection, ad_client_id, optional_params \\ [], opts \\ []) View Source

List all host custom channels in this AdSense account.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client for which to list custom channels.
  • optional_params (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.AdSenseHost.V41.Model.CustomChannels{}} on success {:error, info} on failure

Link to this function

adsensehost_customchannels_patch(connection, ad_client_id, custom_channel_id, optional_params \\ [], opts \\ []) View Source

Update a custom channel in the host AdSense account. This method supports patch semantics.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client in which the custom channel will be updated.
  • custom_channel_id (String.t): Custom channel to get.
  • optional_params (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.
    • :body (CustomChannel):

Returns

{:ok, %GoogleApi.AdSenseHost.V41.Model.CustomChannel{}} on success {:error, info} on failure

Link to this function

adsensehost_customchannels_update(connection, ad_client_id, optional_params \\ [], opts \\ []) View Source

Update a custom channel in the host AdSense account.

Parameters

  • connection (GoogleApi.AdSenseHost.V41.Connection): Connection to server
  • ad_client_id (String.t): Ad client in which the custom channel will be updated.
  • optional_params (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.
    • :body (CustomChannel):

Returns

{:ok, %GoogleApi.AdSenseHost.V41.Model.CustomChannel{}} on success {:error, info} on failure