google_api_partners

v0.1.0

google_api_partners v0.1.0 GoogleApi.Partners.V2.Api.Offers View Source

API calls for all endpoints tagged Offers.

Link to this section Summary

Functions

partners_offers_history_list(connection, opts \\ [])

Lists the Historical Offers for the current user (or user's entire company)

partners_offers_list(connection, opts \\ [])

Lists the Offers available for the current user

Link to this section Functions

Link to this function partners_offers_history_list(connection, opts \\ []) View Source 
partners_offers_history_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.ListOffersHistoryResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the Historical Offers for the current user (or user's entire company)

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :requestMetadata.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
    • :requestMetadata.partnersSessionId (String.t): Google Partners session ID.
    • :pageToken (String.t): Token to retrieve a specific page.
    • :pageSize (integer()): Maximum number of rows to return per page.
    • :requestMetadata.trafficSource.trafficSourceId (String.t): Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
    • :requestMetadata.locale (String.t): Locale to use for the current request.
    • :requestMetadata.userOverrides.ipAddress (String.t): IP address to use instead of the user's geo-located IP address.
    • :requestMetadata.experimentIds ([String.t]): Experiment IDs the current request belongs to.
    • :entireCompany (boolean()): if true, show history for the entire company. Requires user to be admin.
    • :orderBy (String.t): Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo desc" to sort descending. List of valid field names is: name, offer_code, expiration_time, status, last_modified_time, sender_name, creation_time, country_code, offer_type.
    • :requestMetadata.trafficSource.trafficSubId (String.t): Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.

Returns

{:ok, %GoogleApi.Partners.V2.Model.ListOffersHistoryResponse{}} on success {:error, info} on failure

Link to this function partners_offers_list(connection, opts \\ []) View Source 
partners_offers_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.ListOffersResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the Offers available for the current user

Parameters

  • connection (GoogleApi.Partners.V2.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :requestMetadata.experimentIds ([String.t]): Experiment IDs the current request belongs to.
    • :requestMetadata.trafficSource.trafficSubId (String.t): Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
    • :requestMetadata.partnersSessionId (String.t): Google Partners session ID.
    • :requestMetadata.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
    • :requestMetadata.trafficSource.trafficSourceId (String.t): Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
    • :requestMetadata.locale (String.t): Locale to use for the current request.
    • :requestMetadata.userOverrides.ipAddress (String.t): IP address to use instead of the user's geo-located IP address.

Returns

{:ok, %GoogleApi.Partners.V2.Model.ListOffersResponse{}} on success {:error, info} on failure