File: adsensehost_v4_1.associationsessions.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (152 lines) | stat: -rw-r--r-- 5,545 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.associationsessions.html">associationsessions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#start">start(productCode, websiteUrl, callbackUrl=None, userLocale=None, websiteLocale=None)</a></code></p>
<p class="firstline">Create an association session for initiating an association with an AdSense user.</p>
<p class="toc_element">
  <code><a href="#verify">verify(token)</a></code></p>
<p class="firstline">Verify an association session after the association callback returns from AdSense signup.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="start">start(productCode, websiteUrl, callbackUrl=None, userLocale=None, websiteLocale=None)</code>
  <pre>Create an association session for initiating an association with an AdSense user.

Args:
  productCode: string, Products to associate with the user. (required) (repeated)
    Allowed values
      AFC - AdSense For Content
      AFG - AdSense For Games
      AFMC - AdSense For Mobile Content - deprecated
      AFS - AdSense For Search - deprecated
      AFV - AdSense For Video
  websiteUrl: string, The URL of the user&#x27;s hosted website. (required)
  callbackUrl: string, The URL to redirect the user to once association is completed. It receives a token parameter that can then be used to retrieve the associated account.
  userLocale: string, The preferred locale of the user.
  websiteLocale: string, The locale of the user&#x27;s hosted website.

Returns:
  An object of the form:

    {
  &quot;accountId&quot;: &quot;A String&quot;, # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
  &quot;id&quot;: &quot;A String&quot;, # Unique identifier of this association session.
  &quot;kind&quot;: &quot;adsensehost#associationSession&quot;, # Kind of resource this is, in this case adsensehost#associationSession.
  &quot;productCodes&quot;: [ # The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)
    &quot;A String&quot;,
  ],
  &quot;redirectUrl&quot;: &quot;A String&quot;, # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
  &quot;status&quot;: &quot;A String&quot;, # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
  &quot;userLocale&quot;: &quot;A String&quot;, # The preferred locale of the user themselves when going through the AdSense association flow.
  &quot;websiteLocale&quot;: &quot;A String&quot;, # The locale of the user&#x27;s hosted website.
  &quot;websiteUrl&quot;: &quot;A String&quot;, # The URL of the user&#x27;s hosted website.
}</pre>
</div>

<div class="method">
    <code class="details" id="verify">verify(token)</code>
  <pre>Verify an association session after the association callback returns from AdSense signup.

Args:
  token: string, The token returned to the association callback URL. (required)

Returns:
  An object of the form:

    {
  &quot;accountId&quot;: &quot;A String&quot;, # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
  &quot;id&quot;: &quot;A String&quot;, # Unique identifier of this association session.
  &quot;kind&quot;: &quot;adsensehost#associationSession&quot;, # Kind of resource this is, in this case adsensehost#associationSession.
  &quot;productCodes&quot;: [ # The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)
    &quot;A String&quot;,
  ],
  &quot;redirectUrl&quot;: &quot;A String&quot;, # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
  &quot;status&quot;: &quot;A String&quot;, # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
  &quot;userLocale&quot;: &quot;A String&quot;, # The preferred locale of the user themselves when going through the AdSense association flow.
  &quot;websiteLocale&quot;: &quot;A String&quot;, # The locale of the user&#x27;s hosted website.
  &quot;websiteUrl&quot;: &quot;A String&quot;, # The URL of the user&#x27;s hosted website.
}</pre>
</div>

</body></html>