GoogleApi.AdSense.V14.Api.Adunits (google_api_ad_sense v0.18.0)
View SourceAPI calls for all endpoints tagged Adunits
.
Summary
Functions
List all custom channels which the specified ad unit belongs to.
Gets the specified ad unit in the specified ad client.
adsense_adunits_get_ad_code(connection, ad_client_id, ad_unit_id, optional_params \\ [], opts \\ [])
Get ad code for the specified ad unit.
List all ad units in the specified ad client for this AdSense account.
Functions
@spec adsense_adunits_customchannels_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSense.V14.Model.CustomChannels.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List all custom channels which the specified ad unit belongs to.
Parameters
-
connection
(type:GoogleApi.AdSense.V14.Connection.t
) - Connection to server -
ad_client_id
(type:String.t
) - Ad client which contains the ad unit. -
ad_unit_id
(type:String.t
) - Ad unit for which to list custom channels. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:maxResults
(type:integer()
) - The maximum number of custom channels to include in the response, used for paging. -
:pageToken
(type: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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSense.V14.Model.CustomChannels{}}
on success -
{:error, info}
on failure
@spec adsense_adunits_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSense.V14.Model.AdUnit.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified ad unit in the specified ad client.
Parameters
-
connection
(type:GoogleApi.AdSense.V14.Connection.t
) - Connection to server -
ad_client_id
(type:String.t
) - Ad client for which to get the ad unit. -
ad_unit_id
(type:String.t
) - Ad unit to retrieve. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSense.V14.Model.AdUnit{}}
on success -
{:error, info}
on failure
@spec adsense_adunits_get_ad_code( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AdSense.V14.Model.AdCode.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get ad code for the specified ad unit.
Parameters
-
connection
(type:GoogleApi.AdSense.V14.Connection.t
) - Connection to server -
ad_client_id
(type:String.t
) - Ad client with contains the ad unit. -
ad_unit_id
(type:String.t
) - Ad unit to get the code for. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSense.V14.Model.AdCode{}}
on success -
{:error, info}
on failure
@spec adsense_adunits_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.AdSense.V14.Model.AdUnits.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
List all ad units in the specified ad client for this AdSense account.
Parameters
-
connection
(type:GoogleApi.AdSense.V14.Connection.t
) - Connection to server -
ad_client_id
(type:String.t
) - Ad client for which to list ad units. -
optional_params
(type:keyword()
) - Optional parameters-
:alt
(type:String.t
) - Data format for the response. -
: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters. -
:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead. -
:includeInactive
(type:boolean()
) - Whether to include inactive ad units. Default: true. -
:maxResults
(type:integer()
) - The maximum number of ad units to include in the response, used for paging. -
:pageToken
(type:String.t
) - A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AdSense.V14.Model.AdUnits{}}
on success -
{:error, info}
on failure