Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.sites.html">sites</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#add">add(siteUrl)</a></code></p>
     79 <p class="firstline">Adds a site to the set of the user's sites in Search Console.</p>
     80 <p class="toc_element">
     81   <code><a href="#delete">delete(siteUrl)</a></code></p>
     82 <p class="firstline">Removes a site from the set of the user's Search Console sites.</p>
     83 <p class="toc_element">
     84   <code><a href="#get">get(siteUrl)</a></code></p>
     85 <p class="firstline">Retrieves information about specific site.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list()</a></code></p>
     88 <p class="firstline">Lists the user's Search Console sites.</p>
     89 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="add">add(siteUrl)</code>
     92   <pre>Adds a site to the set of the user's sites in Search Console.
     93 
     94 Args:
     95   siteUrl: string, The URL of the site to add. (required)
     96 </pre>
     97 </div>
     98 
     99 <div class="method">
    100     <code class="details" id="delete">delete(siteUrl)</code>
    101   <pre>Removes a site from the set of the user's Search Console sites.
    102 
    103 Args:
    104   siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
    105 </pre>
    106 </div>
    107 
    108 <div class="method">
    109     <code class="details" id="get">get(siteUrl)</code>
    110   <pre>Retrieves information about specific site.
    111 
    112 Args:
    113   siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
    114 
    115 Returns:
    116   An object of the form:
    117 
    118     { # Contains permission level information about a Search Console site. For more information, see  Permissions in Search Console.
    119     "permissionLevel": "A String", # The user's permission level for the site.
    120     "siteUrl": "A String", # The URL of the site.
    121   }</pre>
    122 </div>
    123 
    124 <div class="method">
    125     <code class="details" id="list">list()</code>
    126   <pre>Lists the user's Search Console sites.
    127 
    128 Args:
    129 
    130 Returns:
    131   An object of the form:
    132 
    133     { # List of sites with access level information.
    134     "siteEntry": [ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
    135       { # Contains permission level information about a Search Console site. For more information, see  Permissions in Search Console.
    136         "permissionLevel": "A String", # The user's permission level for the site.
    137         "siteUrl": "A String", # The URL of the site.
    138       },
    139     ],
    140   }</pre>
    141 </div>
    142 
    143 </body></html>