GoogleApi.DFAReporting.V34.Api.Placements (google_api_dfa_reporting v0.31.0)

API calls for all endpoints tagged Placements.

Summary

Functions

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

Generates tags for a placement.

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

Gets one placement by ID.

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

Inserts a new placement.

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

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

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

Updates an existing placement. This method supports patch semantics.

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

Updates an existing placement.

Functions

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

@spec dfareporting_placements_generatetags(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.PlacementsGenerateTagsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates tags for a placement.

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
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :campaignId (type: String.t) - Generate placements belonging to this campaign. This is a required field.
- :placementIds (type: list(String.t)) - Generate tags for these placements.
- :tagFormats (type: list(String.t)) - Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.PlacementsGenerateTagsResponse{}} on success
{:error, info} on failure

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

@spec dfareporting_placements_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Placement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one placement 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) - Placement ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Placement{}} on success
{:error, info} on failure

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

@spec dfareporting_placements_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Placement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new placement.

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
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.DFAReporting.V34.Model.Placement.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Placement{}} on success
{:error, info} on failure

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

@spec dfareporting_placements_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.PlacementsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of placements, 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
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :advertiserIds (type: list(String.t)) - Select only placements that belong to these advertisers.
- :archived (type: boolean()) - Select only archived placements. Don't set this field to select both archived and non-archived placements.
- :campaignIds (type: list(String.t)) - Select only placements that belong to these campaigns.
- :compatibilities (type: list(String.t)) - Select only placements that are associated with these compatibilities. 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 in in-stream video ads developed with the VAST standard.
- :contentCategoryIds (type: list(String.t)) - Select only placements that are associated with these content categories.
- :directorySiteIds (type: list(String.t)) - Select only placements that are associated with these directory sites.
- :groupIds (type: list(String.t)) - Select only placements that belong to these placement groups.
- :ids (type: list(String.t)) - Select only placements with these IDs.
- :maxEndDate (type: String.t) - Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
- :maxResults (type: integer()) - Maximum number of results to return.
- :maxStartDate (type: String.t) - Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
- :minEndDate (type: String.t) - Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
- :minStartDate (type: String.t) - Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
- :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
- :paymentSource (type: String.t) - Select only placements with this payment source.
- :placementStrategyIds (type: list(String.t)) - Select only placements that are associated with these placement strategies.
- :pricingTypes (type: list(String.t)) - Select only placements with these pricing types.
- :searchString (type: String.t) - Allows searching for placements by name or ID. Wildcards () are allowed. For example, "placement2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 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 "placement" will match placements with name "my placement", "placement 2015", or simply "placement" .
- :siteIds (type: list(String.t)) - Select only placements that are associated with these sites.
- :sizeIds (type: list(String.t)) - Select only placements that are associated with these sizes.
- :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.PlacementsListResponse{}} on success
{:error, info} on failure

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

@spec dfareporting_placements_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Placement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing placement. This method supports patch semantics.

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) - Placement ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.DFAReporting.V34.Model.Placement.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Placement{}} on success
{:error, info} on failure

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

@spec dfareporting_placements_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.Placement.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing placement.

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
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.DFAReporting.V34.Model.Placement.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.Placement{}} on success
{:error, info} on failure