google_api_dfa_reporting v0.15.0 GoogleApi.DFAReporting.V33.Api.Advertisers View Source

API calls for all endpoints tagged Advertisers.

Link to this section Summary

Link to this section Functions

Link to this function

dfareporting_advertisers_get(connection, profile_id, id, optional_params \\ [], opts \\ [])

View Source

Specs

dfareporting_advertisers_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets one advertiser by ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Advertiser 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.Advertiser{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_advertisers_insert(connection, profile_id, optional_params \\ [], opts \\ [])

View Source

Specs

dfareporting_advertisers_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Inserts a new advertiser.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.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.
    • :body (type: GoogleApi.DFAReporting.V33.Model.Advertiser.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.Advertiser{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_advertisers_list(connection, profile_id, optional_params \\ [], opts \\ [])

View Source

Specs

dfareporting_advertisers_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.AdvertisersListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a list of advertisers, possibly filtered. This method supports paging.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.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.
    • :advertiserGroupIds (type: list(String.t)) - Select only advertisers with these advertiser group IDs.
    • :floodlightConfigurationIds (type: list(String.t)) - Select only advertisers with these floodlight configuration IDs.
    • :ids (type: list(String.t)) - Select only advertisers with these IDs.
    • :includeAdvertisersWithoutGroupsOnly (type: boolean()) - Select only advertisers which do not belong to any advertiser group.
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :onlyParent (type: boolean()) - Select only advertisers which use another advertiser's floodlight configuration.
    • :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 June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
    • :sortField (type: String.t) - Field by which to sort the list.
    • :sortOrder (type: String.t) - Order of sorted results.
    • :status (type: String.t) - Select only advertisers with the specified status.
    • :subaccountId (type: String.t) - Select only advertisers with these subaccount IDs.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.AdvertisersListResponse{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_advertisers_patch(connection, profile_id, id, optional_params \\ [], opts \\ [])

View Source

Specs

dfareporting_advertisers_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing advertiser. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - User profile ID associated with this request.
  • id (type: String.t) - Advertiser 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.Advertiser.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.Advertiser{}} on success
  • {:error, info} on failure
Link to this function

dfareporting_advertisers_update(connection, profile_id, optional_params \\ [], opts \\ [])

View Source

Specs

dfareporting_advertisers_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Advertiser.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing advertiser.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.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.
    • :body (type: GoogleApi.DFAReporting.V33.Model.Advertiser.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.Advertiser{}} on success
  • {:error, info} on failure