twitapi

package module
v0.0.0-...-ecec2e8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 4, 2020 License: MIT Imports: 23 Imported by: 0

README

Go API client for twitapi

API Reference — v2

Quick example to get tweets from the last 7 days that match a search query

package main

import (
	"context"
	"fmt"
	"os"
	"time"

	"github.com/antihax/optional"
	"github.com/kylebevans/twitapi"
)

func main() {

	ctx := context.WithValue(context.Background(), twitapi.ContextAccessToken, os.Getenv("TWITTER_BEARER_TOKEN"))
	cfg := twitapi.NewConfiguration()
	apiClient := twitapi.NewAPIClient(cfg)
	var searchOpts *twitapi.TweetsRecentSearchOpts
	searchOpts = new(twitapi.TweetsRecentSearchOpts)
	var tweets twitapi.TweetSearchResponse
	var nextToken optional.String
	var err error

	// API is paginated, so print pages of recent tweets in the last week
	// that mention "tasty sandwich" until they are all done
	for ok := true; ok; ok = (tweets.Meta.NextToken != "") {

		tweets, _, err = apiClient.SearchApi.TweetsRecentSearch(ctx, "\"tasty sandwich\"", searchOpts)

		if err != nil {
			panic(err)
		}

		for _, v := range tweets.Data {
			fmt.Printf("%v\n\u001b[31m--------\n\u001b[0m", v.Text)
		}

		nextToken = optional.NewString(tweets.Meta.NextToken)
		searchOpts.NextToken = nextToken
		time.Sleep(2 * time.Second) // Twitter API is rate limited to 450 requests per 15 min
	}
}

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 2.2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://developer.twitter.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./twitapi"

Documentation for API Endpoints

All URIs are relative to https://api.twitter.com

Class Method HTTP request Description
GeneralApi GetOpenApiSpec Get /2/openapi.json Returns the open api spec document.
RulesApi AddOrDeleteRules Post /2/tweets/search/stream/rules Add or delete rules from a user's active rule set.
RulesApi GetRules Get /2/tweets/search/stream/rules Returns rules from a user's active rule set.
SearchApi TweetsFullarchiveSearch Get /2/tweets/search/all Returns Tweets that match a search query.
SearchApi TweetsRecentSearch Get /2/tweets/search/recent Returns Tweets from the last 7 days that match a search query.
TweetsApi AddOrDeleteRules Post /2/tweets/search/stream/rules Add or delete rules from a user's active rule set.
TweetsApi FindTweetById Get /2/tweets/{id} Returns hydrated Tweet objects
TweetsApi FindTweetsById Get /2/tweets Returns hydrated Tweet objects
TweetsApi GetRules Get /2/tweets/search/stream/rules Returns rules from a user's active rule set.
TweetsApi HideReplyById Put /2/tweets/{id}/hidden Hides or unhides a reply to an owned conversation.
TweetsApi SampleStream Get /2/tweets/sample/stream Streams a deterministic 1% of public tweets.
TweetsApi SearchStream Get /2/tweets/search/stream Streams tweets matching a user's active rule set.
TweetsApi TweetsFullarchiveSearch Get /2/tweets/search/all Returns Tweets that match a search query.
TweetsApi TweetsRecentSearch Get /2/tweets/search/recent Returns Tweets from the last 7 days that match a search query.
UsersApi FindUserById Get /2/users/{id} Return details for the specified users
UsersApi FindUserByUsername Get /2/users/by/username/{username} Return details for the specified users
UsersApi FindUsersById Get /2/users Return details for the specified users
UsersApi FindUsersByUsername Get /2/users/by Return details for the specified users

Documentation For Models

Documentation For Authorization

BearerToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

UserToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	GeneralApi *GeneralApiService

	RulesApi *RulesApiService

	SearchApi *SearchApiService

	TweetsApi *TweetsApiService

	UsersApi *UsersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Early Access API v2.2 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AddOrDeleteRulesOpts 

type AddOrDeleteRulesOpts struct {
	DryRun optional.Bool
}

AddOrDeleteRulesOpts Optional parameters for the method 'AddOrDeleteRules'

type AddOrDeleteRulesRequest 

type AddOrDeleteRulesRequest struct {
	Add    []RuleNoId `json:"add"`
	Ids    []string   `json:"ids,omitempty"`
	Values []string   `json:"values,omitempty"`
}

AddOrDeleteRulesRequest struct for AddOrDeleteRulesRequest

type AddOrDeleteRulesResponse 

type AddOrDeleteRulesResponse struct {
	Data []Rule                `json:"data"`
	Meta RulesResponseMetadata `json:"meta"`
}

AddOrDeleteRulesResponse struct for AddOrDeleteRulesResponse

type AddRulesRequest 

type AddRulesRequest struct {
	Add []RuleNoId `json:"add"`
}

AddRulesRequest struct for AddRulesRequest

type AddRulesResponse 

type AddRulesResponse struct {
	Data []Rule                `json:"data"`
	Meta RulesResponseMetadata `json:"meta"`
}

AddRulesResponse struct for AddRulesResponse

type AnimatedGif 

type AnimatedGif struct {
	// The Media Key identifier for this attachment.
	MediaKey string `json:"media_key,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width           int32  `json:"width,omitempty"`
	Type            string `json:"type,omitempty"`
	PreviewImageUrl string `json:"preview_image_url,omitempty"`
}

AnimatedGif struct for AnimatedGif

type AnimatedGifAllOf 

type AnimatedGifAllOf struct {
	Type            string `json:"type,omitempty"`
	PreviewImageUrl string `json:"preview_image_url,omitempty"`
}

AnimatedGifAllOf struct for AnimatedGifAllOf

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CashtagEntity 

type CashtagEntity struct {
	// Index (zero-based) at which position this entity starts.
	Start int32 `json:"start"`
	// Index (zero-based) at which position this entity ends.
	End int32  `json:"end"`
	Tag string `json:"tag"`
}

CashtagEntity struct for CashtagEntity

type CashtagFields 

type CashtagFields struct {
	Tag string `json:"tag"`
}

CashtagFields Represent the portion of text recognized as a Cashtag, and its start and end position within the text.

type ClientDisconnectedProblem 

type ClientDisconnectedProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
}

ClientDisconnectedProblem Your client has gone away.

type ClientDisconnectedProblemAllOf 

type ClientDisconnectedProblemAllOf struct {
	Type string `json:"type,omitempty"`
}

ClientDisconnectedProblemAllOf struct for ClientDisconnectedProblemAllOf

type ClientForbiddenProblem 

type ClientForbiddenProblem struct {
	Title           string `json:"title"`
	Detail          string `json:"detail"`
	Type            string `json:"type,omitempty"`
	Reason          string `json:"reason,omitempty"`
	RegistrationUrl string `json:"registration_url,omitempty"`
}

ClientForbiddenProblem A problem that indicates your client is forbidden from making this request.

type ClientForbiddenProblemAllOf 

type ClientForbiddenProblemAllOf struct {
	Type            string `json:"type,omitempty"`
	Reason          string `json:"reason,omitempty"`
	RegistrationUrl string `json:"registration_url,omitempty"`
}

ClientForbiddenProblemAllOf struct for ClientForbiddenProblemAllOf

type CommonMediaFields 

type CommonMediaFields struct {
	// The Media Key identifier for this attachment.
	MediaKey string `json:"media_key,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width int32 `json:"width,omitempty"`
}

CommonMediaFields struct for CommonMediaFields

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConnectionExceptionProblem 

type ConnectionExceptionProblem struct {
	Title           string `json:"title"`
	Detail          string `json:"detail"`
	Type            string `json:"type,omitempty"`
	ConnectionIssue string `json:"connection_issue,omitempty"`
}

ConnectionExceptionProblem A problem that indicates something is wrong with the connection

type ConnectionExceptionProblemAllOf 

type ConnectionExceptionProblemAllOf struct {
	Type            string `json:"type,omitempty"`
	ConnectionIssue string `json:"connection_issue,omitempty"`
}

ConnectionExceptionProblemAllOf struct for ConnectionExceptionProblemAllOf

type ContextAnnotation 

type ContextAnnotation struct {
	Domain ContextAnnotationDomainFields `json:"domain"`
	Entity ContextAnnotationEntityFields `json:"entity"`
}

ContextAnnotation Annotation inferred from the tweet text.

type ContextAnnotationDomainFields 

type ContextAnnotationDomainFields struct {
	// The unique id for a context annotation domain.
	Id string `json:"id"`
	// Name of the context annotation domain.
	Name string `json:"name,omitempty"`
	// Description of the context annotation domain.
	Description string `json:"description,omitempty"`
}

ContextAnnotationDomainFields Represents the data for the context annotation domain.

type ContextAnnotationEntityFields 

type ContextAnnotationEntityFields struct {
	// The unique id for a context annotation entity.
	Id string `json:"id"`
	// Name of the context annotation entity.
	Name string `json:"name,omitempty"`
	// Description of the context annotation entity.
	Description string `json:"description,omitempty"`
}

ContextAnnotationEntityFields Represents the data for the context annotation entity.

type DeleteRulesRequest 

type DeleteRulesRequest struct {
	Delete RuleDeleteIds `json:"delete"`
}

DeleteRulesRequest struct for DeleteRulesRequest

type DeleteRulesResponse 

type DeleteRulesResponse struct {
	Meta RulesResponseMetadata `json:"meta"`
}

DeleteRulesResponse struct for DeleteRulesResponse

type DisallowedResourceProblem 

type DisallowedResourceProblem struct {
	Title        string `json:"title"`
	Detail       string `json:"detail"`
	Type         string `json:"type,omitempty"`
	ResourceId   string `json:"resource_id"`
	ResourceType string `json:"resource_type"`
	Section      string `json:"section"`
}

DisallowedResourceProblem A problem that indicates that the resource requested violates the precepts of this API.

type DisallowedResourceProblemAllOf 

type DisallowedResourceProblemAllOf struct {
	Type         string `json:"type,omitempty"`
	ResourceId   string `json:"resource_id"`
	ResourceType string `json:"resource_type"`
	Section      string `json:"section"`
}

DisallowedResourceProblemAllOf struct for DisallowedResourceProblemAllOf

type DuplicateRuleProblem 

type DuplicateRuleProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
}

DuplicateRuleProblem The rule you have submitted is a duplicate.

type DuplicateRuleProblemAllOf 

type DuplicateRuleProblemAllOf struct {
	Type string `json:"type,omitempty"`
}

DuplicateRuleProblemAllOf struct for DuplicateRuleProblemAllOf

type EntityIndices 

type EntityIndices struct {
	// Index (zero-based) at which position this entity starts.
	Start int32 `json:"start"`
	// Index (zero-based) at which position this entity ends.
	End int32 `json:"end"`
}

EntityIndices Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). `start` must be smaller than `end`.

type Error 

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

Error struct for Error

type Expansions 

type Expansions struct {
	Users  []User  `json:"users,omitempty"`
	Tweets []Tweet `json:"tweets,omitempty"`
	Places []Place `json:"places,omitempty"`
	Media  []Media `json:"media,omitempty"`
	Polls  []Poll  `json:"polls,omitempty"`
}

Expansions struct for Expansions

type FieldUnauthorizedProblem 

type FieldUnauthorizedProblem struct {
	Title        string `json:"title"`
	Detail       string `json:"detail"`
	Type         string `json:"type,omitempty"`
	Section      string `json:"section"`
	ResourceType string `json:"resource_type"`
	Field        string `json:"field"`
}

FieldUnauthorizedProblem A problem that indicates that you are not allowed to see a particular field on a Tweet, User, etc.

type FieldUnauthorizedProblemAllOf 

type FieldUnauthorizedProblemAllOf struct {
	Type         string `json:"type,omitempty"`
	Section      string `json:"section"`
	ResourceType string `json:"resource_type"`
	Field        string `json:"field"`
}

FieldUnauthorizedProblemAllOf struct for FieldUnauthorizedProblemAllOf

type FilteredStreamingTweet 

type FilteredStreamingTweet struct {
	Data Tweet `json:"data"`
	// The list of rules which matched the tweet
	MatchingRules []FilteredStreamingTweetOneOfMatchingRules `json:"matching_rules"`
	Includes      Expansions                                 `json:"includes,omitempty"`
	Errors        []Problem                                  `json:"errors"`
}

FilteredStreamingTweet A tweet or error that can be returned by the streaming tweet API

type FilteredStreamingTweetOneOf 

type FilteredStreamingTweetOneOf struct {
	Data Tweet `json:"data"`
	// The list of rules which matched the tweet
	MatchingRules []FilteredStreamingTweetOneOfMatchingRules `json:"matching_rules"`
	Includes      Expansions                                 `json:"includes,omitempty"`
}

FilteredStreamingTweetOneOf The values returned with a successful streamed tweet. Includes the user provided rules that the tweet matched.

type FilteredStreamingTweetOneOfMatchingRules 

type FilteredStreamingTweetOneOfMatchingRules struct {
	// Unique identifier of this rule.
	Id int64 `json:"id"`
	// The user-supplied tag assigned to the rule which matched
	Tag string `json:"tag,omitempty"`
}

FilteredStreamingTweetOneOfMatchingRules struct for FilteredStreamingTweetOneOfMatchingRules

type FindTweetByIdOpts 

type FindTweetByIdOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

FindTweetByIdOpts Optional parameters for the method 'FindTweetById'

type FindTweetsByIdOpts 

type FindTweetsByIdOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

FindTweetsByIdOpts Optional parameters for the method 'FindTweetsById'

type FindUserByIdOpts 

type FindUserByIdOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
}

FindUserByIdOpts Optional parameters for the method 'FindUserById'

type FindUserByUsernameOpts 

type FindUserByUsernameOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
}

FindUserByUsernameOpts Optional parameters for the method 'FindUserByUsername'

type FindUsersByIdOpts 

type FindUsersByIdOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
}

FindUsersByIdOpts Optional parameters for the method 'FindUsersById'

type FindUsersByUsernameOpts 

type FindUsersByUsernameOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
}

FindUsersByUsernameOpts Optional parameters for the method 'FindUsersByUsername'

type FullTextEntities 

type FullTextEntities struct {
	Urls     []UrlEntity     `json:"urls,omitempty"`
	Hashtags []HashtagEntity `json:"hashtags,omitempty"`
	Mentions []MentionEntity `json:"mentions,omitempty"`
	Cashtags []CashtagEntity `json:"cashtags,omitempty"`
}

FullTextEntities struct for FullTextEntities

type GeneralApiService 

type GeneralApiService service

GeneralApiService GeneralApi service

func (*GeneralApiService) GetOpenApiSpec 

func (a *GeneralApiService) GetOpenApiSpec(ctx _context.Context) (map[string]interface{}, *_nethttp.Response, error)

GetOpenApiSpec Returns the open api spec document. Full open api spec in JSON format. (See https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]interface{}

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GenericProblem 

type GenericProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
	Status int32  `json:"status"`
}

GenericProblem A generic problem with no additional information beyond that provided by the HTTP status code.

type GenericProblemAllOf 

type GenericProblemAllOf struct {
	Type   string `json:"type,omitempty"`
	Status int32  `json:"status"`
}

GenericProblemAllOf struct for GenericProblemAllOf

type Geo 

type Geo struct {
	Type       string                 `json:"type"`
	Bbox       []float64              `json:"bbox"`
	Geometry   Point                  `json:"geometry,omitempty"`
	Properties map[string]interface{} `json:"properties"`
}

Geo struct for Geo

type GetRulesOpts 

type GetRulesOpts struct {
	Ids optional.Interface
}

GetRulesOpts Optional parameters for the method 'GetRules'

type HashtagEntity 

type HashtagEntity struct {
	// Index (zero-based) at which position this entity starts.
	Start int32 `json:"start"`
	// Index (zero-based) at which position this entity ends.
	End int32 `json:"end"`
	// The text of the Hashtag
	Tag string `json:"tag"`
}

HashtagEntity struct for HashtagEntity

type HashtagFields 

type HashtagFields struct {
	// The text of the Hashtag
	Tag string `json:"tag"`
}

HashtagFields Represent the portion of text recognized as a Hashtag, and its start and end position within the text.

type HideReplyByIdOpts 

type HideReplyByIdOpts struct {
	InlineObject optional.Interface
}

HideReplyByIdOpts Optional parameters for the method 'HideReplyById'

type InlineObject 

type InlineObject struct {
	Hidden bool `json:"hidden,omitempty"`
}

InlineObject struct for InlineObject

type InlineResponse200 

type InlineResponse200 struct {
	Data InlineResponse200Data `json:"data,omitempty"`
}

InlineResponse200 struct for InlineResponse200

type InlineResponse2001 

type InlineResponse2001 struct {
	Data     []Tweet                `json:"data,omitempty"`
	Includes Expansions             `json:"includes,omitempty"`
	Errors   []Problem              `json:"errors,omitempty"`
	Meta     InlineResponse2001Meta `json:"meta,omitempty"`
}

InlineResponse2001 struct for InlineResponse2001

type InlineResponse2001Meta 

type InlineResponse2001Meta struct {
	// Most recent Tweet Id returned by search query
	NewestId string `json:"newest_id,omitempty"`
	// Oldest Tweet Id returned by search query
	OldestId string `json:"oldest_id,omitempty"`
	// This value is used to get the next 'page' of results by providing it to the next_token parameter.
	NextToken string `json:"next_token,omitempty"`
	// Number of search query results
	ResultCount int32 `json:"result_count,omitempty"`
}

InlineResponse2001Meta struct for InlineResponse2001Meta

type InlineResponse2002 

type InlineResponse2002 struct {
	Data []Rule                `json:"data"`
	Meta RulesResponseMetadata `json:"meta"`
}

InlineResponse2002 struct for InlineResponse2002

type InlineResponse200Data 

type InlineResponse200Data struct {
	Hidden bool `json:"hidden,omitempty"`
}

InlineResponse200Data struct for InlineResponse200Data

type InvalidRequestProblem 

type InvalidRequestProblem struct {
	Title  string                             `json:"title"`
	Detail string                             `json:"detail"`
	Type   string                             `json:"type,omitempty"`
	Errors []InvalidRequestProblemAllOfErrors `json:"errors,omitempty"`
}

InvalidRequestProblem A problem that indicates this request is invalid.

type InvalidRequestProblemAllOf 

type InvalidRequestProblemAllOf struct {
	Type   string                             `json:"type,omitempty"`
	Errors []InvalidRequestProblemAllOfErrors `json:"errors,omitempty"`
}

InvalidRequestProblemAllOf struct for InvalidRequestProblemAllOf

type InvalidRequestProblemAllOfErrors 

type InvalidRequestProblemAllOfErrors struct {
	Parameters map[string][]string `json:"parameters,omitempty"`
	Message    string              `json:"message,omitempty"`
}

InvalidRequestProblemAllOfErrors struct for InvalidRequestProblemAllOfErrors

type InvalidRuleProblem 

type InvalidRuleProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
}

InvalidRuleProblem The rule you have submitted is invalid.

type InvalidRuleProblemAllOf 

type InvalidRuleProblemAllOf struct {
	Type string `json:"type,omitempty"`
}

InvalidRuleProblemAllOf struct for InvalidRuleProblemAllOf

type Media 

type Media struct {
	// The Media Key identifier for this attachment.
	MediaKey string `json:"media_key,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width            int32                      `json:"width,omitempty"`
	Type             string                     `json:"type"`
	Url              string                     `json:"url,omitempty"`
	PreviewImageUrl  string                     `json:"preview_image_url,omitempty"`
	DurationMs       int32                      `json:"duration_ms,omitempty"`
	PublicMetrics    VideoAllOfPublicMetrics    `json:"public_metrics,omitempty"`
	NonPublicMetrics VideoAllOfNonPublicMetrics `json:"non_public_metrics,omitempty"`
	OrganicMetrics   VideoAllOfOrganicMetrics   `json:"organic_metrics,omitempty"`
	PromotedMetrics  VideoAllOfPromotedMetrics  `json:"promoted_metrics,omitempty"`
}

Media struct for Media

type MentionEntity 

type MentionEntity struct {
	// Index (zero-based) at which position this entity starts.
	Start int32 `json:"start"`
	// Index (zero-based) at which position this entity ends.
	End int32 `json:"end"`
	// The Twitter handle (screen name) of this user.
	Username string `json:"username"`
}

MentionEntity struct for MentionEntity

type MentionFields 

type MentionFields struct {
	// The Twitter handle (screen name) of this user.
	Username string `json:"username"`
}

MentionFields Represent the portion of text recognized as a User mention, and its start and end position within the text.

type OperationalDisconnectProblem 

type OperationalDisconnectProblem struct {
	Title          string `json:"title"`
	Detail         string `json:"detail"`
	Type           string `json:"type,omitempty"`
	DisconnectType string `json:"disconnect_type,omitempty"`
}

OperationalDisconnectProblem You have been disconnected for operational reasons.

type OperationalDisconnectProblemAllOf 

type OperationalDisconnectProblemAllOf struct {
	Type           string `json:"type,omitempty"`
	DisconnectType string `json:"disconnect_type,omitempty"`
}

OperationalDisconnectProblemAllOf struct for OperationalDisconnectProblemAllOf

type Photo 

type Photo struct {
	// The Media Key identifier for this attachment.
	MediaKey string `json:"media_key,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width int32  `json:"width,omitempty"`
	Type  string `json:"type,omitempty"`
	Url   string `json:"url,omitempty"`
}

Photo struct for Photo

type PhotoAllOf 

type PhotoAllOf struct {
	Type string `json:"type,omitempty"`
	Url  string `json:"url,omitempty"`
}

PhotoAllOf struct for PhotoAllOf

type Place 

type Place struct {
	// The identifier for this place
	Id string `json:"id"`
	// The human readable name of this place.
	Name            string    `json:"name,omitempty"`
	CountryCode     string    `json:"country_code,omitempty"`
	PlaceType       PlaceType `json:"place_type,omitempty"`
	FullName        string    `json:"full_name"`
	Country         string    `json:"country,omitempty"`
	ContainedWithin []string  `json:"contained_within,omitempty"`
	Geo             Geo       `json:"geo,omitempty"`
}

Place struct for Place

type PlaceType 

type PlaceType string

PlaceType the model 'PlaceType' 

const (
	POI          PlaceType = "poi"
	NEIGHBORHOOD PlaceType = "neighborhood"
	CITY         PlaceType = "city"
	ADMIN        PlaceType = "admin"
	COUNTRY      PlaceType = "country"
	UNKNOWN      PlaceType = "unknown"
)

List of PlaceType

type Point 

type Point struct {
	Type string `json:"type"`
	// A [GeoJson Position](https://tools.ietf.org/html/rfc7946#section-3.1.1) in the format `[longitude,latitude]`.
	Coordinates []float32 `json:"coordinates"`
}

Point A [GeoJson Point](https://tools.ietf.org/html/rfc7946#section-3.1.2) geometry object.

type Poll 

type Poll struct {
	// Unique identifier of this poll.
	Id              string       `json:"id"`
	Options         []PollOption `json:"options"`
	VotingStatus    string       `json:"voting_status,omitempty"`
	EndDatetime     time.Time    `json:"end_datetime,omitempty"`
	DurationMinutes int32        `json:"duration_minutes,omitempty"`
}

Poll Represent a Poll attached to a Tweet

type PollOption 

type PollOption struct {
	// Position of this choice in the poll.
	Position int32 `json:"position"`
	// The text of a poll choice.
	Label string `json:"label"`
	// Number of users who voted for this choice.
	Votes int32 `json:"votes"`
}

PollOption Describes a choice in a Poll object.

type Problem 

type Problem struct {
	Title           string                             `json:"title"`
	Detail          string                             `json:"detail"`
	Type            string                             `json:"type"`
	Status          int32                              `json:"status"`
	Errors          []InvalidRequestProblemAllOfErrors `json:"errors,omitempty"`
	Reason          string                             `json:"reason,omitempty"`
	RegistrationUrl string                             `json:"registration_url,omitempty"`
	Parameter       string                             `json:"parameter"`
	Value           string                             `json:"value"`
	ResourceType    string                             `json:"resource_type"`
	Section         string                             `json:"section"`
	Field           string                             `json:"field"`
	ResourceId      string                             `json:"resource_id"`
	Period          string                             `json:"period,omitempty"`
	Scope           string                             `json:"scope,omitempty"`
	ConnectionIssue string                             `json:"connection_issue,omitempty"`
	DisconnectType  string                             `json:"disconnect_type,omitempty"`
}

Problem An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

type ProblemFields 

type ProblemFields struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
}

ProblemFields struct for ProblemFields

type ReplySettings 

type ReplySettings string

ReplySettings Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, and following. 

const (
	EVERYONE        ReplySettings = "everyone"
	MENTIONED_USERS ReplySettings = "mentionedUsers"
	FOLLOWING       ReplySettings = "following"
	OTHER           ReplySettings = "other"
)

List of ReplySettings

type ResourceNotFoundProblem 

type ResourceNotFoundProblem struct {
	Title     string `json:"title"`
	Detail    string `json:"detail"`
	Type      string `json:"type,omitempty"`
	Parameter string `json:"parameter"`
	// Value will match the schema of the field.
	Value        interface{} `json:"value"`
	ResourceType string      `json:"resource_type"`
}

ResourceNotFoundProblem A problem that indicates that a given Tweet, User, etc. does not exist.

type ResourceNotFoundProblemAllOf 

type ResourceNotFoundProblemAllOf struct {
	Type      string `json:"type,omitempty"`
	Parameter string `json:"parameter"`
	// Value will match the schema of the field.
	Value        interface{} `json:"value"`
	ResourceType string      `json:"resource_type"`
}

ResourceNotFoundProblemAllOf struct for ResourceNotFoundProblemAllOf

type ResourceUnauthorizedProblem 

type ResourceUnauthorizedProblem struct {
	Title        string `json:"title"`
	Detail       string `json:"detail"`
	Type         string `json:"type,omitempty"`
	Value        string `json:"value"`
	Parameter    string `json:"parameter"`
	Section      string `json:"section"`
	ResourceType string `json:"resource_type"`
}

ResourceUnauthorizedProblem A problem that indicates you are not allowed to see a particular Tweet, User, etc.

type ResourceUnauthorizedProblemAllOf 

type ResourceUnauthorizedProblemAllOf struct {
	Type         string `json:"type,omitempty"`
	Value        string `json:"value"`
	Parameter    string `json:"parameter"`
	Section      string `json:"section"`
	ResourceType string `json:"resource_type"`
}

ResourceUnauthorizedProblemAllOf struct for ResourceUnauthorizedProblemAllOf

type Rule 

type Rule struct {
	// The filterlang value of the rule.
	Value string `json:"value"`
	// A tag meant for the labeling of user provided rules.
	Tag string `json:"tag,omitempty"`
	// Unique identifier of this rule.
	Id string `json:"id,omitempty"`
}

Rule struct for Rule

type RuleDeleteIds 

type RuleDeleteIds struct {
	// The filterlang value of the rule.
	Ids []string `json:"ids"`
}

RuleDeleteIds struct for RuleDeleteIds

type RuleNoId 

type RuleNoId struct {
	// The filterlang value of the rule.
	Value string `json:"value"`
	// A tag meant for the labeling of user provided rules.
	Tag string `json:"tag,omitempty"`
}

RuleNoId struct for RuleNoId

type RulesApiService 

type RulesApiService service

RulesApiService RulesApi service

func (*RulesApiService) AddOrDeleteRules 

func (a *RulesApiService) AddOrDeleteRules(ctx _context.Context, addOrDeleteRulesRequest AddOrDeleteRulesRequest, localVarOptionals *AddOrDeleteRulesOpts) (AddOrDeleteRulesResponse, *_nethttp.Response, error)

AddOrDeleteRules Add or delete rules from a user's active rule set. Add or delete rules from a user's active rule set. Users can provide unique, optionally tagged rules to add. Users can delete their entire rule set or a subset specified by rule ids or values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param addOrDeleteRulesRequest
  • @param optional nil or *AddOrDeleteRulesOpts - Optional Parameters:
  • @param "DryRun" (optional.Bool) - Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes.

@return AddOrDeleteRulesResponse

func (*RulesApiService) GetRules 

func (a *RulesApiService) GetRules(ctx _context.Context, localVarOptionals *GetRulesOpts) (InlineResponse2002, *_nethttp.Response, error)

GetRules Returns rules from a user's active rule set. Returns rules from a user's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetRulesOpts - Optional Parameters:
  • @param "Ids" (optional.Interface of []string) - A comma-separated list of Rule IDs.

@return InlineResponse2002

type RulesCapProblem 

type RulesCapProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
}

RulesCapProblem You have exceeded the maximum number of rules.

type RulesCapProblemAllOf 

type RulesCapProblemAllOf struct {
	Type string `json:"type,omitempty"`
}

RulesCapProblemAllOf struct for RulesCapProblemAllOf

type RulesRequestSummary 

type RulesRequestSummary struct {
	Created    int32 `json:"created"`
	NotCreated int32 `json:"not_created"`
	Deleted    int32 `json:"deleted"`
	NotDeleted int32 `json:"not_deleted"`
}

RulesRequestSummary struct for RulesRequestSummary

type RulesRequestSummaryOneOf 

type RulesRequestSummaryOneOf struct {
	Created    int32 `json:"created"`
	NotCreated int32 `json:"not_created"`
}

RulesRequestSummaryOneOf struct for RulesRequestSummaryOneOf

type RulesRequestSummaryOneOf1 

type RulesRequestSummaryOneOf1 struct {
	Deleted    int32 `json:"deleted"`
	NotDeleted int32 `json:"not_deleted"`
}

RulesRequestSummaryOneOf1 struct for RulesRequestSummaryOneOf1

type RulesResponseMetadata 

type RulesResponseMetadata struct {
	Sent    string              `json:"sent"`
	Summary RulesRequestSummary `json:"summary,omitempty"`
}

RulesResponseMetadata struct for RulesResponseMetadata

type SampleStreamOpts 

type SampleStreamOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

SampleStreamOpts Optional parameters for the method 'SampleStream'

type SearchApiService 

type SearchApiService service

SearchApiService SearchApi service

func (*SearchApiService) TweetsFullarchiveSearch 

func (a *SearchApiService) TweetsFullarchiveSearch(ctx _context.Context, query string, localVarOptionals *TweetsFullarchiveSearchOpts) (InlineResponse2001, *_nethttp.Response, error)

TweetsFullarchiveSearch Returns Tweets that match a search query. Returns Tweets that match a search query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param query One query/rule/filter for matching Tweets. Up to 1024 characters.
  • @param optional nil or *TweetsFullarchiveSearchOpts - Optional Parameters:
  • @param "StartTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
  • @param "EndTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
  • @param "SinceId" (optional.String) - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.
  • @param "UntilId" (optional.String) - Returns results with a Tweet ID less than (that is, older than) the specified ID.
  • @param "MaxResults" (optional.Int32) - The maximum number of search results to be returned by a request.
  • @param "NextToken" (optional.String) - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return InlineResponse2001

func (*SearchApiService) TweetsRecentSearch 

func (a *SearchApiService) TweetsRecentSearch(ctx _context.Context, query string, localVarOptionals *TweetsRecentSearchOpts) (TweetSearchResponse, *_nethttp.Response, error)

TweetsRecentSearch Returns Tweets from the last 7 days that match a search query. Returns Tweets from the last 7 days that match a search query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param query One query/rule/filter for matching Tweets. Up to 512 characters.
  • @param optional nil or *TweetsRecentSearchOpts - Optional Parameters:
  • @param "StartTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
  • @param "EndTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
  • @param "SinceId" (optional.String) - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.
  • @param "UntilId" (optional.String) - Returns results with a Tweet ID less than (that is, older than) the specified ID.
  • @param "MaxResults" (optional.Int32) - The maximum number of search results to be returned by a request.
  • @param "NextToken" (optional.String) - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return TweetSearchResponse

type SearchStreamOpts 

type SearchStreamOpts struct {
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

SearchStreamOpts Optional parameters for the method 'SearchStream'

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SingleTweetLookupResponse 

type SingleTweetLookupResponse struct {
	Data     Tweet      `json:"data,omitempty"`
	Includes Expansions `json:"includes,omitempty"`
	Errors   []Problem  `json:"errors,omitempty"`
}

SingleTweetLookupResponse struct for SingleTweetLookupResponse

type SingleUserLookupResponse 

type SingleUserLookupResponse struct {
	Data     User       `json:"data,omitempty"`
	Includes Expansions `json:"includes,omitempty"`
	Errors   []Problem  `json:"errors,omitempty"`
}

SingleUserLookupResponse struct for SingleUserLookupResponse

type StreamingTweet 

type StreamingTweet struct {
	Data     Tweet      `json:"data,omitempty"`
	Includes Expansions `json:"includes,omitempty"`
	Errors   []Problem  `json:"errors"`
}

StreamingTweet A tweet or error that can be returned by the streaming tweet API.

type StreamingTweetOneOf 

type StreamingTweetOneOf struct {
	Errors []Problem `json:"errors"`
}

StreamingTweetOneOf struct for StreamingTweetOneOf

type Tweet 

type Tweet struct {
	// Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	Id string `json:"id"`
	// Creation time of the Tweet.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// The content of the Tweet.
	Text string `json:"text"`
	// Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	AuthorId string `json:"author_id,omitempty"`
	// Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	InReplyToUserId string `json:"in_reply_to_user_id,omitempty"`
	// Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	ConversationId string        `json:"conversation_id,omitempty"`
	ReplySettings  ReplySettings `json:"reply_settings,omitempty"`
	// A list of Tweets this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.
	ReferencedTweets   []TweetReferencedTweets `json:"referenced_tweets,omitempty"`
	Attachments        TweetAttachments        `json:"attachments,omitempty"`
	ContextAnnotations []ContextAnnotation     `json:"context_annotations,omitempty"`
	Withheld           TweetWithheld           `json:"withheld,omitempty"`
	Geo                TweetGeo                `json:"geo,omitempty"`
	Entities           FullTextEntities        `json:"entities,omitempty"`
	PublicMetrics      TweetPublicMetrics      `json:"public_metrics,omitempty"`
	// Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.
	PossiblySensitive bool `json:"possibly_sensitive,omitempty"`
	// Language of the Tweet, if detected by Twitter. Returned as a BCP47 language tag.
	Lang string `json:"lang,omitempty"`
	// The name of the app the user Tweeted from.
	Source           string                `json:"source,omitempty"`
	NonPublicMetrics TweetNonPublicMetrics `json:"non_public_metrics,omitempty"`
	PromotedMetrics  TweetPromotedMetrics  `json:"promoted_metrics,omitempty"`
	OrganicMetrics   TweetOrganicMetrics   `json:"organic_metrics,omitempty"`
}

Tweet struct for Tweet

type TweetAttachments 

type TweetAttachments struct {
	// A list of Media Keys for each one of the media attachments (if media are attached).
	MediaKeys []string `json:"media_keys,omitempty"`
	// A list of poll IDs (if polls are attached).
	PollIds []string `json:"poll_ids,omitempty"`
}

TweetAttachments Specifies the type of attachments (if any) present in this Tweet.

type TweetGeo 

type TweetGeo struct {
	Coordinates Point `json:"coordinates,omitempty"`
	// The identifier for this place
	PlaceId string `json:"place_id,omitempty"`
}

TweetGeo The location tagged on the Tweet, if the user provided one.

type TweetLookupResponse 

type TweetLookupResponse struct {
	Data     []Tweet                 `json:"data,omitempty"`
	Includes Expansions              `json:"includes,omitempty"`
	Errors   []Problem               `json:"errors,omitempty"`
	Meta     TweetLookupResponseMeta `json:"meta,omitempty"`
}

TweetLookupResponse struct for TweetLookupResponse

type TweetLookupResponseMeta 

type TweetLookupResponseMeta struct {
	// The next cursor provided by the response.
	NextToken string `json:"next_token,omitempty"`
	// The ID of the oldest Tweet in the response.
	OldestId string `json:"oldest_id,omitempty"`
	// The ID of the newest Tweet in the response.
	NewestId string `json:"newest_id,omitempty"`
	// The previous cursor provided by the response.
	PreviousToken string `json:"previous_token,omitempty"`
	// Number of results returned in the response.
	ResultCount int32 `json:"result_count,omitempty"`
}

TweetLookupResponseMeta struct for TweetLookupResponseMeta

type TweetNonPublicMetrics 

type TweetNonPublicMetrics struct {
	// Number of times this Tweet has been viewed.
	ImpressionCount int32 `json:"impression_count,omitempty"`
}

TweetNonPublicMetrics Nonpublic engagement metrics for the Tweet at the time of the request.

type TweetOrganicMetrics 

type TweetOrganicMetrics struct {
	// Number of times this Tweet has been viewed.
	ImpressionCount int32 `json:"impression_count"`
	// Number of times this Tweet has been Retweeted.
	RetweetCount int32 `json:"retweet_count"`
	// Number of times this Tweet has been replied to.
	ReplyCount int32 `json:"reply_count"`
	// Number of times this Tweet has been liked.
	LikeCount int32 `json:"like_count"`
}

TweetOrganicMetrics Organic nonpublic engagement metrics for the Tweet at the time of the request.

type TweetPromotedMetrics 

type TweetPromotedMetrics struct {
	// Number of times this Tweet has been viewed.
	ImpressionCount int32 `json:"impression_count,omitempty"`
	// Number of times this Tweet has been liked.
	LikeCount int32 `json:"like_count,omitempty"`
	// Number of times this Tweet has been replied to.
	ReplyCount int32 `json:"reply_count,omitempty"`
	// Number of times this Tweet has been Retweeted.
	RetweetCount int32 `json:"retweet_count,omitempty"`
}

TweetPromotedMetrics Promoted nonpublic engagement metrics for the Tweet at the time of the request.

type TweetPublicMetrics 

type TweetPublicMetrics struct {
	// Number of times this Tweet has been Retweeted.
	RetweetCount int32 `json:"retweet_count"`
	// Number of times this Tweet has been replied to.
	ReplyCount int32 `json:"reply_count"`
	// Number of times this Tweet has been liked.
	LikeCount int32 `json:"like_count"`
	// Number of times this Tweet has been quoted.
	QuoteCount int32 `json:"quote_count,omitempty"`
}

TweetPublicMetrics Engagement metrics for the Tweet at the time of the request.

type TweetReferencedTweets 

type TweetReferencedTweets struct {
	Type string `json:"type"`
	// Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	Id string `json:"id"`
}

TweetReferencedTweets struct for TweetReferencedTweets

type TweetSearchResponse 

type TweetSearchResponse struct {
	Data     []Tweet                `json:"data,omitempty"`
	Includes Expansions             `json:"includes,omitempty"`
	Errors   []Problem              `json:"errors,omitempty"`
	Meta     InlineResponse2001Meta `json:"meta,omitempty"`
}

TweetSearchResponse struct for TweetSearchResponse

type TweetWithheld 

type TweetWithheld struct {
	// Indicates if the content is being withheld for on the basis of copyright infringement.
	Copyright bool `json:"copyright"`
	// Provides a list of countries where this content is not available.
	CountryCodes []string `json:"country_codes"`
	// Indicates whether the content being withheld is the `tweet` or a `user`.
	Scope string `json:"scope,omitempty"`
}

TweetWithheld Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).

type TweetsApiService 

type TweetsApiService service

TweetsApiService TweetsApi service

func (*TweetsApiService) AddOrDeleteRules 

func (a *TweetsApiService) AddOrDeleteRules(ctx _context.Context, addOrDeleteRulesRequest interface{}, localVarOptionals *AddOrDeleteRulesOpts) (AddOrDeleteRulesResponse, *_nethttp.Response, error)

AddOrDeleteRules Add or delete rules from a user's active rule set. Add or delete rules from a user's active rule set. Users can provide unique, optionally tagged rules to add. Users can delete their entire rule set or a subset specified by rule ids or values.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param addOrDeleteRulesRequest
  • @param optional nil or *AddOrDeleteRulesOpts - Optional Parameters:
  • @param "DryRun" (optional.Bool) - Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes.

@return AddOrDeleteRulesResponse

func (*TweetsApiService) FindTweetById 

func (a *TweetsApiService) FindTweetById(ctx _context.Context, id string, localVarOptionals *FindTweetByIdOpts) (SingleTweetLookupResponse, *_nethttp.Response, error)

FindTweetById Returns hydrated Tweet objects Returns a variety of information about the Tweet specified by the requested ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id A single Tweet ID.
  • @param optional nil or *FindTweetByIdOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return SingleTweetLookupResponse

func (*TweetsApiService) FindTweetsById 

func (a *TweetsApiService) FindTweetsById(ctx _context.Context, ids []string, localVarOptionals *FindTweetsByIdOpts) (TweetLookupResponse, *_nethttp.Response, error)

FindTweetsById Returns hydrated Tweet objects Returns a variety of information about the Tweet specified by the requested ID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ids A comma separated list of Tweet IDs. Up to 100 are allowed in a single request.
  • @param optional nil or *FindTweetsByIdOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return TweetLookupResponse

func (*TweetsApiService) GetRules 

func (a *TweetsApiService) GetRules(ctx _context.Context, localVarOptionals *GetRulesOpts) (InlineResponse2002, *_nethttp.Response, error)

GetRules Returns rules from a user's active rule set. Returns rules from a user's active rule set. Users can fetch all of their rules or a subset, specified by the provided rule ids.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetRulesOpts - Optional Parameters:
  • @param "Ids" (optional.Interface of []string) - A comma-separated list of Rule IDs.

@return InlineResponse2002

func (*TweetsApiService) HideReplyById 

func (a *TweetsApiService) HideReplyById(ctx _context.Context, id string, localVarOptionals *HideReplyByIdOpts) (InlineResponse200, *_nethttp.Response, error)

HideReplyById Hides or unhides a reply to an owned conversation. Tweet ID in the path is that of the reply to hide or unhide.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the reply that you want to hide or unhide.
  • @param optional nil or *HideReplyByIdOpts - Optional Parameters:
  • @param "InlineObject" (optional.Interface of InlineObject) -

@return InlineResponse200

func (*TweetsApiService) SampleStream 

func (a *TweetsApiService) SampleStream(ctx _context.Context, localVarOptionals *SampleStreamOpts) (StreamingTweet, *_nethttp.Response, error)

SampleStream Streams a deterministic 1% of public tweets. Streams a deterministic 1% of public tweets.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SampleStreamOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return StreamingTweet

func (*TweetsApiService) SearchStream 

func (a *TweetsApiService) SearchStream(ctx _context.Context, localVarOptionals *SearchStreamOpts, tweets chan FilteredStreamingTweet, errs chan error)

SearchStream Streams tweets matching a user's active rule set. Streams tweets matching a user's active rule set.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchStreamOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return FilteredStreamingTweet

func (*TweetsApiService) TweetsFullarchiveSearch 

func (a *TweetsApiService) TweetsFullarchiveSearch(ctx _context.Context, query string, localVarOptionals *TweetsFullarchiveSearchOpts) (InlineResponse2001, *_nethttp.Response, error)

TweetsFullarchiveSearch Returns Tweets that match a search query. Returns Tweets that match a search query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param query One query/rule/filter for matching Tweets. Up to 1024 characters.
  • @param optional nil or *TweetsFullarchiveSearchOpts - Optional Parameters:
  • @param "StartTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
  • @param "EndTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
  • @param "SinceId" (optional.String) - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.
  • @param "UntilId" (optional.String) - Returns results with a Tweet ID less than (that is, older than) the specified ID.
  • @param "MaxResults" (optional.Int32) - The maximum number of search results to be returned by a request.
  • @param "NextToken" (optional.String) - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return InlineResponse2001

func (*TweetsApiService) TweetsRecentSearch 

func (a *TweetsApiService) TweetsRecentSearch(ctx _context.Context, query string, localVarOptionals *TweetsRecentSearchOpts) (TweetSearchResponse, *_nethttp.Response, error)

TweetsRecentSearch Returns Tweets from the last 7 days that match a search query. Returns Tweets from the last 7 days that match a search query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param query One query/rule/filter for matching Tweets. Up to 512 characters.
  • @param optional nil or *TweetsRecentSearchOpts - Optional Parameters:
  • @param "StartTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute).
  • @param "EndTime" (optional.Time) - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute).
  • @param "SinceId" (optional.String) - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID.
  • @param "UntilId" (optional.String) - Returns results with a Tweet ID less than (that is, older than) the specified ID.
  • @param "MaxResults" (optional.Int32) - The maximum number of search results to be returned by a request.
  • @param "NextToken" (optional.String) - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified.
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.
  • @param "MediaFields" (optional.Interface of []string) - A comma separated list of Media fields to display.
  • @param "PlaceFields" (optional.Interface of []string) - A comma separated list of Place fields to display.
  • @param "PollFields" (optional.Interface of []string) - A comma separated list of Poll fields to display.

@return TweetSearchResponse

type TweetsFullarchiveSearchOpts 

type TweetsFullarchiveSearchOpts struct {
	StartTime   optional.Time
	EndTime     optional.Time
	SinceId     optional.String
	UntilId     optional.String
	MaxResults  optional.Int32
	NextToken   optional.String
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

TweetsFullarchiveSearchOpts Optional parameters for the method 'TweetsFullarchiveSearch'

type TweetsRecentSearchOpts 

type TweetsRecentSearchOpts struct {
	StartTime   optional.Time
	EndTime     optional.Time
	SinceId     optional.String
	UntilId     optional.String
	MaxResults  optional.Int32
	NextToken   optional.String
	Expansions  optional.Interface
	TweetFields optional.Interface
	UserFields  optional.Interface
	MediaFields optional.Interface
	PlaceFields optional.Interface
	PollFields  optional.Interface
}

TweetsRecentSearchOpts Optional parameters for the method 'TweetsRecentSearch'

type UnsupportedAuthenticationProblem 

type UnsupportedAuthenticationProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
}

UnsupportedAuthenticationProblem A problem that indicates that the authentication used is not supported.

type UnsupportedAuthenticationProblemAllOf 

type UnsupportedAuthenticationProblemAllOf struct {
	Type string `json:"type,omitempty"`
}

UnsupportedAuthenticationProblemAllOf struct for UnsupportedAuthenticationProblemAllOf

type UrlEntity 

type UrlEntity struct {
	// Index (zero-based) at which position this entity starts.
	Start int32 `json:"start"`
	// Index (zero-based) at which position this entity ends.
	End int32 `json:"end"`
	// A validly formatted URL.
	Url string `json:"url"`
	// A validly formatted URL.
	ExpandedUrl string `json:"expanded_url,omitempty"`
	// The URL as displayed in the Twitter client.
	DisplayUrl string `json:"display_url,omitempty"`
	// Fully resolved url
	UnwoundUrl string `json:"unwound_url,omitempty"`
	// HTTP Status Code.
	Status int32 `json:"status,omitempty"`
	// Title of the page the URL points to.
	Title string `json:"title,omitempty"`
	// Description of the URL landing page.
	Description string     `json:"description,omitempty"`
	Images      []UrlImage `json:"images,omitempty"`
}

UrlEntity Represent the portion of text recognized as a URL, and its start and end position within the text.

type UrlFields 

type UrlFields struct {
	// A validly formatted URL.
	Url string `json:"url"`
	// A validly formatted URL.
	ExpandedUrl string `json:"expanded_url,omitempty"`
	// The URL as displayed in the Twitter client.
	DisplayUrl string `json:"display_url,omitempty"`
	// Fully resolved url
	UnwoundUrl string `json:"unwound_url,omitempty"`
	// HTTP Status Code.
	Status int32 `json:"status,omitempty"`
	// Title of the page the URL points to.
	Title string `json:"title,omitempty"`
	// Description of the URL landing page.
	Description string     `json:"description,omitempty"`
	Images      []UrlImage `json:"images,omitempty"`
}

UrlFields Represent the portion of text recognized as a URL.

type UrlImage 

type UrlImage struct {
	// A validly formatted URL.
	Url string `json:"url,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width int32 `json:"width,omitempty"`
}

UrlImage Represent the information for the URL image

type UsageCapExceededProblem 

type UsageCapExceededProblem struct {
	Title  string `json:"title"`
	Detail string `json:"detail"`
	Type   string `json:"type,omitempty"`
	Period string `json:"period,omitempty"`
	Scope  string `json:"scope,omitempty"`
}

UsageCapExceededProblem A problem that indicates that a usage cap has been exceeded.

type UsageCapExceededProblemAllOf 

type UsageCapExceededProblemAllOf struct {
	Type   string `json:"type,omitempty"`
	Period string `json:"period,omitempty"`
	Scope  string `json:"scope,omitempty"`
}

UsageCapExceededProblemAllOf struct for UsageCapExceededProblemAllOf

type User 

type User struct {
	// Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	Id string `json:"id"`
	// Creation time of this user.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// The friendly name of this user, as shown on their profile.
	Name string `json:"name"`
	// The Twitter handle (screen name) of this user.
	Username string `json:"username"`
	// Indicates if this user has chosen to protect their Tweets (in other words, if this user's Tweets are private).
	Protected bool `json:"protected,omitempty"`
	// Indicate if this user is a verified Twitter User.
	Verified bool         `json:"verified,omitempty"`
	Withheld UserWithheld `json:"withheld,omitempty"`
	// The URL to the profile image for this user.
	ProfileImageUrl string `json:"profile_image_url,omitempty"`
	// The location specified in the user's profile, if the user provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.
	Location string `json:"location,omitempty"`
	// The URL specified in the user's profile.
	Url string `json:"url,omitempty"`
	// The text of this user's profile description (also known as bio), if the user provided one.
	Description string       `json:"description,omitempty"`
	Entities    UserEntities `json:"entities,omitempty"`
	// Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
	PinnedTweetId string            `json:"pinned_tweet_id,omitempty"`
	PublicMetrics UserPublicMetrics `json:"public_metrics,omitempty"`
}

User The Twitter User object

type UserEntities 

type UserEntities struct {
	Url         UserEntitiesUrl  `json:"url,omitempty"`
	Description FullTextEntities `json:"description,omitempty"`
}

UserEntities A list of metadata found in the user's profile description.

type UserEntitiesUrl 

type UserEntitiesUrl struct {
	Urls []UrlEntity `json:"urls,omitempty"`
}

UserEntitiesUrl Expanded details for the URL specified in the user's profile, with start and end indices.

type UserLookupResponse 

type UserLookupResponse struct {
	Data     []User     `json:"data,omitempty"`
	Includes Expansions `json:"includes,omitempty"`
	Errors   []Problem  `json:"errors,omitempty"`
}

UserLookupResponse struct for UserLookupResponse

type UserPublicMetrics 

type UserPublicMetrics struct {
	// Number of users who are following this user.
	FollowersCount int32 `json:"followers_count"`
	// Number of users this user is following.
	FollowingCount int32 `json:"following_count"`
	// The number of Tweets (including Retweets) posted by this user.
	TweetCount int32 `json:"tweet_count"`
	// The number of lists that include this user.
	ListedCount int32 `json:"listed_count"`
}

UserPublicMetrics A list of metrics for this user

type UserWithheld 

type UserWithheld struct {
	// Provides a list of countries where this content is not available.
	CountryCodes []string `json:"country_codes"`
	// Indicates that the content being withheld is a `user`.
	Scope string `json:"scope,omitempty"`
}

UserWithheld Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).

type UsersApiService 

type UsersApiService service

UsersApiService UsersApi service

func (*UsersApiService) FindUserById 

func (a *UsersApiService) FindUserById(ctx _context.Context, id string, localVarOptionals *FindUserByIdOpts) (SingleUserLookupResponse, *_nethttp.Response, error)

FindUserById Return details for the specified users This endpoint returns information about a user. Specify user by ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Required. A User ID.
  • @param optional nil or *FindUserByIdOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.

@return SingleUserLookupResponse

func (*UsersApiService) FindUserByUsername 

func (a *UsersApiService) FindUserByUsername(ctx _context.Context, username string, localVarOptionals *FindUserByUsernameOpts) (SingleUserLookupResponse, *_nethttp.Response, error)

FindUserByUsername Return details for the specified users This endpoint returns information about a user. Specify user by username.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param username Required. A username.
  • @param optional nil or *FindUserByUsernameOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.

@return SingleUserLookupResponse

func (*UsersApiService) FindUsersById 

func (a *UsersApiService) FindUsersById(ctx _context.Context, ids []string, localVarOptionals *FindUsersByIdOpts) (UserLookupResponse, *_nethttp.Response, error)

FindUsersById Return details for the specified users This endpoint returns information about users. Specify users by their ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ids Required. A list of User IDs, comma-separated. You can specify up to 100 IDs.
  • @param optional nil or *FindUsersByIdOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.

@return UserLookupResponse

func (*UsersApiService) FindUsersByUsername 

func (a *UsersApiService) FindUsersByUsername(ctx _context.Context, usernames []string, localVarOptionals *FindUsersByUsernameOpts) (UserLookupResponse, *_nethttp.Response, error)

FindUsersByUsername Return details for the specified users This endpoint returns information about users. Specify users by their username.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param usernames Required . A list of usernames, comma-separated. You can specify up to 100 usernames.
  • @param optional nil or *FindUsersByUsernameOpts - Optional Parameters:
  • @param "Expansions" (optional.Interface of []string) - A comma separated list of fields to expand.
  • @param "TweetFields" (optional.Interface of []string) - A comma separated list of Tweet fields to display.
  • @param "UserFields" (optional.Interface of []string) - A comma separated list of User fields to display.

@return UserLookupResponse

type Video 

type Video struct {
	// The Media Key identifier for this attachment.
	MediaKey string `json:"media_key,omitempty"`
	// The height of the media in pixels
	Height int32 `json:"height,omitempty"`
	// The width of the media in pixels
	Width            int32                      `json:"width,omitempty"`
	Type             string                     `json:"type,omitempty"`
	PreviewImageUrl  string                     `json:"preview_image_url,omitempty"`
	DurationMs       int32                      `json:"duration_ms,omitempty"`
	PublicMetrics    VideoAllOfPublicMetrics    `json:"public_metrics,omitempty"`
	NonPublicMetrics VideoAllOfNonPublicMetrics `json:"non_public_metrics,omitempty"`
	OrganicMetrics   VideoAllOfOrganicMetrics   `json:"organic_metrics,omitempty"`
	PromotedMetrics  VideoAllOfPromotedMetrics  `json:"promoted_metrics,omitempty"`
}

Video struct for Video

type VideoAllOf 

type VideoAllOf struct {
	Type             string                     `json:"type,omitempty"`
	PreviewImageUrl  string                     `json:"preview_image_url,omitempty"`
	DurationMs       int32                      `json:"duration_ms,omitempty"`
	PublicMetrics    VideoAllOfPublicMetrics    `json:"public_metrics,omitempty"`
	NonPublicMetrics VideoAllOfNonPublicMetrics `json:"non_public_metrics,omitempty"`
	OrganicMetrics   VideoAllOfOrganicMetrics   `json:"organic_metrics,omitempty"`
	PromotedMetrics  VideoAllOfPromotedMetrics  `json:"promoted_metrics,omitempty"`
}

VideoAllOf struct for VideoAllOf

type VideoAllOfNonPublicMetrics 

type VideoAllOfNonPublicMetrics struct {
	// Number of users who made it through 0% of the video.
	Playback0Count int32 `json:"playback_0_count,omitempty"`
	// Number of users who made it through 25% of the video.
	Playback25Count int32 `json:"playback_25_count,omitempty"`
	// Number of users who made it through 50% of the video.
	Playback50Count int32 `json:"playback_50_count,omitempty"`
	// Number of users who made it through 75% of the video.
	Playback75Count int32 `json:"playback_75_count,omitempty"`
	// Number of users who made it through 100% of the video.
	Playback100Count int32 `json:"playback_100_count,omitempty"`
}

VideoAllOfNonPublicMetrics Nonpublic engagement metrics for the Media at the time of the request.

type VideoAllOfOrganicMetrics 

type VideoAllOfOrganicMetrics struct {
	// Number of users who made it through 0% of the video.
	Playback0Count int32 `json:"playback_0_count,omitempty"`
	// Number of users who made it through 25% of the video.
	Playback25Count int32 `json:"playback_25_count,omitempty"`
	// Number of users who made it through 50% of the video.
	Playback50Count int32 `json:"playback_50_count,omitempty"`
	// Number of users who made it through 75% of the video.
	Playback75Count int32 `json:"playback_75_count,omitempty"`
	// Number of users who made it through 100% of the video.
	Playback100Count int32 `json:"playback_100_count,omitempty"`
	// Number of times this video has been viewed.
	ViewCount int32 `json:"view_count,omitempty"`
}

VideoAllOfOrganicMetrics Organic nonpublic engagement metrics for the Media at the time of the request.

type VideoAllOfPromotedMetrics 

type VideoAllOfPromotedMetrics struct {
	// Number of users who made it through 0% of the video.
	Playback0Count int32 `json:"playback_0_count,omitempty"`
	// Number of users who made it through 25% of the video.
	Playback25Count int32 `json:"playback_25_count,omitempty"`
	// Number of users who made it through 50% of the video.
	Playback50Count int32 `json:"playback_50_count,omitempty"`
	// Number of users who made it through 75% of the video.
	Playback75Count int32 `json:"playback_75_count,omitempty"`
	// Number of users who made it through 100% of the video.
	Playback100Count int32 `json:"playback_100_count,omitempty"`
	// Number of times this video has been viewed.
	ViewCount int32 `json:"view_count,omitempty"`
}

VideoAllOfPromotedMetrics Promoted nonpublic engagement metrics for the Media at the time of the request.

type VideoAllOfPublicMetrics 

type VideoAllOfPublicMetrics struct {
	// Number of times this video has been viewed.
	ViewCount int32 `json:"view_count,omitempty"`
}

VideoAllOfPublicMetrics Engagement metrics for the Media at the time of the request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.