google_api_dfa_reporting v0.15.0 GoogleApi.DFAReporting.V34.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets one project by ID.
Retrieves a list of projects, possibly filtered. This method supports paging.
Link to this section Functions
Link to this function
dfareporting_projects_get(connection, profile_id, id, optional_params \\ [], opts \\ [])
View SourceSpecs
dfareporting_projects_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DFAReporting.V34.Model.Project.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets one project by ID.
Parameters
-
connection
(type:GoogleApi.DFAReporting.V34.Connection.t
) - Connection to server -
profile_id
(type:String.t
) - User profile ID associated with this request. -
id
(type:String.t
) - Project 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.V34.Model.Project{}}
on success -
{:error, info}
on failure
Link to this function
dfareporting_projects_list(connection, profile_id, optional_params \\ [], opts \\ [])
View SourceSpecs
dfareporting_projects_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.DFAReporting.V34.Model.ProjectsListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves a list of projects, possibly filtered. This method supports paging.
Parameters
-
connection
(type:GoogleApi.DFAReporting.V34.Connection.t
) - Connection to server -
profile_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. -
:advertiserIds
(type:list(String.t)
) - Select only projects with these advertiser IDs. -
:ids
(type:list(String.t)
) - Select only projects 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 projects by name or ID. Wildcards () are allowed. For example, "project2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project". -
: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.V34.Model.ProjectsListResponse{}}
on success -
{:error, info}
on failure