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="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.directorySiteContacts.html">directorySiteContacts</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(profileId, id)</a></code></p>
     79 <p class="firstline">Gets one directory site contact by ID.</p>
     80 <p class="toc_element">
     81   <code><a href="#list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</a></code></p>
     82 <p class="firstline">Retrieves a list of directory site contacts, possibly filtered. This method supports paging.</p>
     83 <p class="toc_element">
     84   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     85 <p class="firstline">Retrieves the next page of results.</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="get">get(profileId, id)</code>
     89   <pre>Gets one directory site contact by ID.
     90 
     91 Args:
     92   profileId: string, User profile ID associated with this request. (required)
     93   id: string, Directory site contact ID. (required)
     94 
     95 Returns:
     96   An object of the form:
     97 
     98     { # Contains properties of a Site Directory contact.
     99     "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    100     "firstName": "A String", # First name of this directory site contact.
    101     "title": "A String", # Title or designation of this directory site contact.
    102     "lastName": "A String", # Last name of this directory site contact.
    103     "email": "A String", # Email address of this directory site contact.
    104     "phone": "A String", # Phone number of this directory site contact.
    105     "role": "A String", # Directory site contact role.
    106     "address": "A String", # Address of this directory site contact.
    107     "type": "A String", # Directory site contact type.
    108     "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
    109   }</pre>
    110 </div>
    111 
    112 <div class="method">
    113     <code class="details" id="list">list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)</code>
    114   <pre>Retrieves a list of directory site contacts, possibly filtered. This method supports paging.
    115 
    116 Args:
    117   profileId: string, User profile ID associated with this request. (required)
    118   searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
    119   directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
    120   pageToken: string, Value of the nextPageToken from the previous result page.
    121   sortField: string, Field by which to sort the list.
    122     Allowed values
    123       ID - 
    124       NAME - 
    125   ids: string, Select only directory site contacts with these IDs. (repeated)
    126   maxResults: integer, Maximum number of results to return.
    127   sortOrder: string, Order of sorted results.
    128     Allowed values
    129       ASCENDING - 
    130       DESCENDING - 
    131 
    132 Returns:
    133   An object of the form:
    134 
    135     { # Directory Site Contact List Response
    136     "nextPageToken": "A String", # Pagination token to be used for the next list operation.
    137     "directorySiteContacts": [ # Directory site contact collection
    138       { # Contains properties of a Site Directory contact.
    139         "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
    140         "firstName": "A String", # First name of this directory site contact.
    141         "title": "A String", # Title or designation of this directory site contact.
    142         "lastName": "A String", # Last name of this directory site contact.
    143         "email": "A String", # Email address of this directory site contact.
    144         "phone": "A String", # Phone number of this directory site contact.
    145         "role": "A String", # Directory site contact role.
    146         "address": "A String", # Address of this directory site contact.
    147         "type": "A String", # Directory site contact type.
    148         "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
    149       },
    150     ],
    151     "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
    152   }</pre>
    153 </div>
    154 
    155 <div class="method">
    156     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    157   <pre>Retrieves the next page of results.
    158 
    159 Args:
    160   previous_request: The request for the previous page. (required)
    161   previous_response: The response from the request for the previous page. (required)
    162 
    163 Returns:
    164   A request object that you can call 'execute()' on to request the next
    165   page. Returns None if there are no more items in the collection.
    166     </pre>
    167 </div>
    168 
    169 </body></html>