google_api_dfa_reporting v0.8.0 GoogleApi.DFAReporting.V33.Api.Ads View Source
API calls for all endpoints tagged Ads
.
Link to this section Summary
Functions
Gets one ad by ID.
Inserts a new ad.
Retrieves a list of ads, possibly filtered. This method supports paging.
Updates an existing ad. This method supports patch semantics.
Updates an existing ad.
Link to this section Functions
Link to this function
dfareporting_ads_get(connection, profile_id, id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_ads_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.Ad.t()} | {:error, Tesla.Env.t()}
Gets one ad by ID.
Parameters
connection
(type:GoogleApi.DFAReporting.V33.Connection.t
) - Connection to serverprofile_id
(type:String.t
) - User profile ID associated with this request.id
(type:String.t
) - Ad ID.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.DFAReporting.V33.Model.Ad{}}
on success{:error, info}
on failure
Link to this function
dfareporting_ads_insert(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_ads_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DFAReporting.V33.Model.Ad.t()} | {:error, Tesla.Env.t()}
Inserts a new ad.
Parameters
connection
(type:GoogleApi.DFAReporting.V33.Connection.t
) - Connection to serverprofile_id
(type:String.t
) - User profile ID associated with this request.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.:body
(type:GoogleApi.DFAReporting.V33.Model.Ad.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.Ad{}}
on success{:error, info}
on failure
Link to this function
dfareporting_ads_list(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_ads_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdsListResponse.t()} | {:error, Tesla.Env.t()}
Retrieves a list of ads, possibly filtered. This method supports paging.
Parameters
connection
(type:GoogleApi.DFAReporting.V33.Connection.t
) - Connection to serverprofile_id
(type:String.t
) - User profile ID associated with this request.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.:active
(type:boolean()
) - Select only active ads.:advertiserId
(type:String.t
) - Select only ads with this advertiser ID.:archived
(type:boolean()
) - Select only archived ads.:audienceSegmentIds
(type:list(String.t)
) - Select only ads with these audience segment IDs.:campaignIds
(type:list(String.t)
) - Select only ads with these campaign IDs.:compatibility
(type:String.t
) - Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.:creativeIds
(type:list(String.t)
) - Select only ads with these creative IDs assigned.:creativeOptimizationConfigurationIds
(type:list(String.t)
) - Select only ads with these creative optimization configuration IDs.:dynamicClickTracker
(type:boolean()
) - Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.:ids
(type:list(String.t)
) - Select only ads with these IDs.:landingPageIds
(type:list(String.t)
) - Select only ads with these landing page IDs.:maxResults
(type:integer()
) - Maximum number of results to return.:overriddenEventTagId
(type:String.t
) - Select only ads with this event tag override ID.:pageToken
(type:String.t
) - Value of the nextPageToken from the previous result page.:placementIds
(type:list(String.t)
) - Select only ads with these placement IDs assigned.:remarketingListIds
(type:list(String.t)
) - Select only ads whose list targeting expression use these remarketing list IDs.:searchString
(type:String.t
) - Allows searching for objects by name or ID. Wildcards () are allowed. For example, "ad2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".:sizeIds
(type:list(String.t)
) - Select only ads with these size IDs.:sortField
(type:String.t
) - Field by which to sort the list.:sortOrder
(type:String.t
) - Order of sorted results.:sslCompliant
(type:boolean()
) - Select only ads that are SSL-compliant.:sslRequired
(type:boolean()
) - Select only ads that require SSL.:type
(type:list(String.t)
) - Select only ads with these types.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.AdsListResponse{}}
on success{:error, info}
on failure
Link to this function
dfareporting_ads_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_ads_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.Ad.t()} | {:error, Tesla.Env.t()}
Updates an existing ad. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.DFAReporting.V33.Connection.t
) - Connection to serverprofile_id
(type:String.t
) - User profile ID associated with this request.id
(type:String.t
) - Ad ID.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.:body
(type:GoogleApi.DFAReporting.V33.Model.Ad.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.Ad{}}
on success{:error, info}
on failure
Link to this function
dfareporting_ads_update(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_ads_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DFAReporting.V33.Model.Ad.t()} | {:error, Tesla.Env.t()}
Updates an existing ad.
Parameters
connection
(type:GoogleApi.DFAReporting.V33.Connection.t
) - Connection to serverprofile_id
(type:String.t
) - User profile ID associated with this request.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.:body
(type:GoogleApi.DFAReporting.V33.Model.Ad.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.Ad{}}
on success{:error, info}
on failure