GoogleApi.DisplayVideo.V1.Api.Advertisers.displayvideo_advertisers_channels_sites_list

You're seeing just the function displayvideo_advertisers_channels_sites_list, go back to GoogleApi.DisplayVideo.V1.Api.Advertisers module for more information.
Link to this function

displayvideo_advertisers_channels_sites_list(connection, advertiser_id, channel_id, optional_params \\ [], opts \\ [])

View Source

Specs

displayvideo_advertisers_channels_sites_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.ListSitesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists sites in a channel.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • advertiser_id (type: String.t) - The ID of the advertiser that owns the parent channel.
  • channel_id (type: String.t) - Required. The ID of the parent channel to which the requested sites belong.
  • 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").
    • :filter (type: String.t) - Allows filtering by site fields. Supported syntax: Filter expressions for site currently can only contain at most one restriction. A restriction has the form of {field} {operator} {value}. The operator must be CONTAINS (:). Supported fields: - urlOrAppId Examples: All sites for which the URL or app ID contains "google": urlOrAppId : "google"
    • :orderBy (type: String.t) - Field by which to sort the list. Acceptable values are: * urlOrAppId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.
    • :pageSize (type: integer()) - Requested page size. Must be between 1 and 10000. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListSites method. If not specified, the first page of results will be returned.
    • :partnerId (type: String.t) - The ID of the partner that owns the parent channel.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.ListSitesResponse{}} on success
  • {:error, info} on failure