Blame - docs/dyn/gan.v1beta1.links.html - platform/external/python/google-api-python-client

<dl><dt><a name="Resource-get">get</a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about a single link if the requesting advertiser/publisher has access to it. Advertisers can look up their own links. Publishers can look up visible links or links belonging to advertisers they are in a relationship with.

18

19

Args:

20

pp: string, A parameter

21

trace: string, A parameter

22

roleId: string, The ID of the requesting advertiser or publisher. (required)

23

strict: string, A parameter

24

role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)

25

Allowed values

26

advertisers - The requester is requesting as an advertiser.

27

publishers - The requester is requesting as a publisher.

28

linkId: string, The ID of the link to look up. (required)

29

userip: string, A parameter

30

31

Returns:

32

An object of the form

33

34

{ # A LinkResource.

35

"startDate": "A String", # Date that this link becomes active.

36

"kind": "gan#link", # The kind for one entity.

37

"endDate": "A String", # Date that this link becomes inactive.

38

"description": "A String", # Description.

39

"name": "A String", # The logical name for this link.

40

"createDate": "A String", # Date that this link was created.

41

"imageAltText": "A String", # image alt text.

42

"id": "A String", # The ID of this link.

43

"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.

44

"creativeType": "A String", # Creative Type.

45

"promotionType": "A String", # Promotion Type

46

"duration": "A String", # Duration

47

"authorship": "A String", # Authorship

48

"availability": "A String", # Availability.

49

"isActive": True or False, # Flag for if this link is active.

50

"destinationUrl": "A String", # The destination URL for the link.

51

}</tt></dd></dl>

52

53

<dl><dt><a name="Resource-insert">insert</a> = method(self, **kwargs)</dt><dd><tt>Inserts a new link.

54

55

Args:

56

body: object, The request body. (required)

57

The object takes the form of:

58

59

{ # A LinkResource.

60

"startDate": "A String", # Date that this link becomes active.

61

"kind": "gan#link", # The kind for one entity.

62

"endDate": "A String", # Date that this link becomes inactive.

63

"description": "A String", # Description.

64

"name": "A String", # The logical name for this link.

65

"createDate": "A String", # Date that this link was created.

66

"imageAltText": "A String", # image alt text.

67

"id": "A String", # The ID of this link.

68

"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.

69

"creativeType": "A String", # Creative Type.

70

"promotionType": "A String", # Promotion Type

71

"duration": "A String", # Duration

72

"authorship": "A String", # Authorship

73

"availability": "A String", # Availability.

74

"isActive": True or False, # Flag for if this link is active.

75

"destinationUrl": "A String", # The destination URL for the link.

76

}

77

78

pp: string, A parameter

79

trace: string, A parameter

80

roleId: string, The ID of the requesting advertiser or publisher. (required)

81

strict: string, A parameter

82

role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)

83

Allowed values

84

advertisers - The requester is requesting as an advertiser.

85

publishers - The requester is requesting as a publisher.

86

userip: string, A parameter

87

88

Returns:

89

An object of the form

90

91

{ # A LinkResource.

92

"startDate": "A String", # Date that this link becomes active.

93

"kind": "gan#link", # The kind for one entity.

94

"endDate": "A String", # Date that this link becomes inactive.

95

"description": "A String", # Description.

96

"name": "A String", # The logical name for this link.

97

"createDate": "A String", # Date that this link was created.

98

"imageAltText": "A String", # image alt text.

99

"id": "A String", # The ID of this link.

100

"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.

101

"creativeType": "A String", # Creative Type.

102

"promotionType": "A String", # Promotion Type

103

"duration": "A String", # Duration

104

"authorship": "A String", # Authorship

105

"availability": "A String", # Availability.

106

"isActive": True or False, # Flag for if this link is active.

107

"destinationUrl": "A String", # The destination URL for the link.

108

}</tt></dd></dl>

109

110

<dl><dt><a name="Resource-list">list</a> = method(self, **kwargs)</dt><dd><tt>Retrieves all links that match the query parameters.

111

112

Args:

113

linkType: string, The type of the link.

Allowed values

banner -

text -

promotionType: string, The promotion type. (repeated)

Allowed values

buy_get -

coupon -

free_gift -

free_gift_wrap -

free_shipping -

none -

ongoing -

percent_off -

price_cut -

product_promotion -

sale -

sweepstakes -

advertiserId: string, Limits the resulting links to the ones belonging to the listed advertisers. (repeated)

132

pp: string, A parameter

133

trace: string, A parameter

134

strict: string, A parameter

135

roleId: string, The ID of the requesting advertiser or publisher. (required)

136

pageToken: string, The value of 'nextPageToken' from the previous page. Optional.

137

role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)

138

Allowed values

139

advertisers - The requester is requesting as an advertiser.

140

publishers - The requester is requesting as a publisher.

141

relationshipStatus: string, The status of the relationship.

Allowed values

approved -

available -

maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.

146

advertiserCategory: string, The advertiser's primary vertical. (repeated)

147

Allowed values

148

apparel_accessories -

149

appliances_electronics -

auto_dealer -

automotive -

babies_kids -

blogs_personal_sites -

books_magazines -

computers -

dating -

department_stores -

education -

employment -

financial_credit_cards -

financial_other -

flowers_gifts -

grocery -

health_beauty -

home_garden -

hosting_domain -

internet_providers -

legal -

media_entertainment -

medical -

movies_games -

music -

nonprofit -

office_supplies -

online_games -

outdoor -

pets -

real_estate -

restaurants -

sport_fitness -

telecom -

ticketing -

toys_hobbies -

travel -

utilities -

wholesale_relationship -

187

wine_spirits -

188

authorship: string, The role of the author of the link.

Allowed values

advertiser -

publisher -

startDateMin: string, The beginning of the start date range.

193

assetSize: string, The size of the given asset. (repeated)

194

startDateMax: string, The end of the start date range.

195

userip: string, A parameter

196

197

Returns:

198

An object of the form

199

200

{

201

"nextPageToken": "A String", # The next page token.

202

"items": [ # The links.

203

{ # A LinkResource.

204

"startDate": "A String", # Date that this link becomes active.

205

"kind": "gan#link", # The kind for one entity.

206

"endDate": "A String", # Date that this link becomes inactive.

207

"description": "A String", # Description.

208

"name": "A String", # The logical name for this link.

209

"createDate": "A String", # Date that this link was created.

210

"imageAltText": "A String", # image alt text.

211

"id": "A String", # The ID of this link.

212

"advertiserId": "A String", # The advertiser id for the advertiser who owns this link.

213

"creativeType": "A String", # Creative Type.

214

"promotionType": "A String", # Promotion Type

215

"duration": "A String", # Duration

216

"authorship": "A String", # Authorship

217

"availability": "A String", # Availability.

218

"isActive": True or False, # Flag for if this link is active.

219

"destinationUrl": "A String", # The destination URL for the link.

220

},

221

],

222

"kind": "gan#links", # The kind for a page of links.

223

}</tt></dd></dl>

224

225

<dl><dt><a name="Resource-list_next">list_next</a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.

226

227

Args:

228

previous_request: The request for the previous page.

229

previous_response: The response from the request for the previous page.

230

231

Returns:

232

A request object that you can call 'execute()' on to request the next