google_api_dfa_reporting v0.8.0 GoogleApi.DFAReporting.V33.Api.AdvertiserGroups View Source
API calls for all endpoints tagged AdvertiserGroups
.
Link to this section Summary
Functions
Deletes an existing advertiser group.
Gets one advertiser group by ID.
Inserts a new advertiser group.
Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
Updates an existing advertiser group. This method supports patch semantics.
Updates an existing advertiser group.
Link to this section Functions
dfareporting_advertiser_groups_delete(connection, profile_id, id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes an existing advertiser group.
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
) - Advertiser group 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, %{}}
on success{:error, info}
on failure
dfareporting_advertiser_groups_get(connection, profile_id, id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdvertiserGroup.t()} | {:error, Tesla.Env.t()}
Gets one advertiser group 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
) - Advertiser group 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.AdvertiserGroup{}}
on success{:error, info}
on failure
dfareporting_advertiser_groups_insert(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdvertiserGroup.t()} | {:error, Tesla.Env.t()}
Inserts a new advertiser group.
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.AdvertiserGroup.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.AdvertiserGroup{}}
on success{:error, info}
on failure
dfareporting_advertiser_groups_list(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdvertiserGroupsListResponse.t()} | {:error, Tesla.Env.t()}
Retrieves a list of advertiser groups, 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.:ids
(type:list(String.t)
) - Select only advertiser groups 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, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".: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.AdvertiserGroupsListResponse{}}
on success{:error, info}
on failure
dfareporting_advertiser_groups_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdvertiserGroup.t()} | {:error, Tesla.Env.t()}
Updates an existing advertiser group. 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
) - Advertiser group 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.AdvertiserGroup.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.AdvertiserGroup{}}
on success{:error, info}
on failure
dfareporting_advertiser_groups_update(connection, profile_id, optional_params \\ [], opts \\ [])
View Sourcedfareporting_advertiser_groups_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V33.Model.AdvertiserGroup.t()} | {:error, Tesla.Env.t()}
Updates an existing advertiser group.
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.AdvertiserGroup.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DFAReporting.V33.Model.AdvertiserGroup{}}
on success{:error, info}
on failure