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

API calls for all endpoints tagged Companies.

Link to this section Summary

Functions

partners_companies_get(connection, company_id, opts \\ [])

Gets a company

partners_companies_leads_create(connection, company_id, opts \\ [])

Creates an advertiser lead for the given company ID

partners_companies_list(connection, opts \\ [])

Lists companies

Link to this section Functions

partners_companies_get(connection, company_id, opts \\ [])

partners_companies_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.GetCompanyResponse.t()}
  | {:error, Tesla.Env.t()}

Gets a company.

Parameters

connection (GoogleApi.Partners.V2.Connection): Connection to server
company_id (String.t): The ID of the company to retrieve.
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.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.userOverrides.ipAddress (String.t): IP address to use instead of the user's geo-located IP address.
- :currencyCode (String.t): If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.
- :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.
- :orderBy (String.t): How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
- :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.
- :view (String.t): The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
- :address (String.t): The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.
- :requestMetadata.locale (String.t): Locale to use for the current request.

Returns

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

partners_companies_leads_create(connection, company_id, opts \\ [])

partners_companies_leads_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.CreateLeadResponse.t()}
  | {:error, Tesla.Env.t()}

Creates an advertiser lead for the given company ID.

Parameters

connection (GoogleApi.Partners.V2.Connection): Connection to server
company_id (String.t): The ID of the company to contact.
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.
- :body (CreateLeadRequest):

Returns

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

partners_companies_list(connection, opts \\ [])

partners_companies_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Partners.V2.Model.ListCompaniesResponse.t()}
  | {:error, Tesla.Env.t()}

Lists companies.

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.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.
- :orderBy (String.t): How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
- :specializations ([String.t]): List of specializations that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these specializations, or one of the services in the "services" field.
- :maxMonthlyBudget.currencyCode (String.t): The 3-letter currency code defined in ISO 4217.
- :requestMetadata.userOverrides.userId (String.t): Logged-in user ID to impersonate instead of the user's ID.
- :minMonthlyBudget.currencyCode (String.t): The 3-letter currency code defined in ISO 4217.
- :view (String.t): The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
- :requestMetadata.locale (String.t): Locale to use for the current request.
- :address (String.t): The address to use when searching for companies. If not given, the geo-located address of the request is used.
- :minMonthlyBudget.units (String.t): The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- :maxMonthlyBudget.nanos (integer()): Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- :services ([String.t]): List of services that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these services, or one of the specializations in the "specializations" field.
- :maxMonthlyBudget.units (String.t): The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- :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.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.
- :minMonthlyBudget.nanos (integer()): Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- :requestMetadata.partnersSessionId (String.t): Google Partners session ID.
- :companyName (String.t): Company name to search for.
- :pageToken (String.t): A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies.
- :industries ([String.t]): List of industries the company can help with.
- :websiteUrl (String.t): Website URL that will help to find a better matched company. .
- :gpsMotivations ([String.t]): List of reasons for using Google Partner Search to get companies.
- :languageCodes ([String.t]): List of language codes that company can support. Only primary language subtags are accepted as defined by <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> (IETF BCP 47, "Tags for Identifying Languages").
- :pageSize (integer()): Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.

Returns

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