| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 75 | <h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.projects.html">projects</a></h1> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Gets one project by ID.</p> |
| 83 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <p class="firstline">Retrieves a list of projects, possibly filtered. This method supports paging .</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <pre>Gets one project by ID. |
| 98 | |
| 99 | Args: |
| 100 | profileId: string, User profile ID associated with this request. (required) |
| 101 | id: string, Project ID. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # Contains properties of a Planning project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 111 | "accountId": "A String", # Account ID of this project. |
| 112 | "advertiserId": "A String", # Advertiser ID of this project. |
| 113 | "audienceAgeGroup": "A String", # Audience age group of this project. |
| 114 | "audienceGender": "A String", # Audience gender of this project. |
| 115 | "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. |
| 116 | "clientBillingCode": "A String", # Client billing code of this project. |
| 117 | "clientName": "A String", # Name of the project client. |
| 118 | "endDate": "A String", |
| 119 | "id": "A String", # ID of this project. This is a read-only, auto-generated field. |
| 120 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". |
| 121 | "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project. |
| 122 | "time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 123 | }, |
| 124 | "name": "A String", # Name of this project. |
| 125 | "overview": "A String", # Overview of this project. |
| 126 | "startDate": "A String", |
| 127 | "subaccountId": "A String", # Subaccount ID of this project. |
| 128 | "targetClicks": "A String", # Number of clicks that the advertiser is targeting. |
| 129 | "targetConversions": "A String", # Number of conversions that the advertiser is targeting. |
| 130 | "targetCpaNanos": "A String", # CPA that the advertiser is targeting. |
| 131 | "targetCpcNanos": "A String", # CPC that the advertiser is targeting. |
| 132 | "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting. |
| 133 | "targetCpmNanos": "A String", # CPM that the advertiser is targeting. |
| 134 | "targetImpressions": "A String", # Number of impressions that the advertiser is targeting. |
| 135 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 139 | <code class="details" id="list">list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 140 | <pre>Retrieves a list of projects, possibly filtered. This method supports paging . |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | |
| 142 | Args: |
| 143 | profileId: string, User profile ID associated with this request. (required) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 144 | advertiserIds: string, Select only projects with these advertiser IDs. (repeated) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 145 | ids: string, Select only projects with these IDs. (repeated) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 146 | maxResults: integer, Maximum number of results to return. |
| 147 | pageToken: string, Value of the nextPageToken from the previous result page. |
| 148 | searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 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 "project" will match projects with name "my project", "project 2015", or simply "project". |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 149 | sortField: string, Field by which to sort the list. |
| 150 | Allowed values |
| 151 | ID - |
| 152 | NAME - |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 153 | sortOrder: string, Order of sorted results. |
| 154 | Allowed values |
| 155 | ASCENDING - |
| 156 | DESCENDING - |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 157 | x__xgafv: string, V1 error format. |
| 158 | Allowed values |
| 159 | 1 - v1 error format |
| 160 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | |
| 162 | Returns: |
| 163 | An object of the form: |
| 164 | |
| 165 | { # Project List Response |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 166 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse". |
| 167 | "nextPageToken": "A String", # Pagination token to be used for the next list operation. |
| 168 | "projects": [ # Project collection. |
| 169 | { # Contains properties of a Planning project. |
| 170 | "accountId": "A String", # Account ID of this project. |
| 171 | "advertiserId": "A String", # Advertiser ID of this project. |
| 172 | "audienceAgeGroup": "A String", # Audience age group of this project. |
| 173 | "audienceGender": "A String", # Audience gender of this project. |
| 174 | "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar. |
| 175 | "clientBillingCode": "A String", # Client billing code of this project. |
| 176 | "clientName": "A String", # Name of the project client. |
| 177 | "endDate": "A String", |
| 178 | "id": "A String", # ID of this project. This is a read-only, auto-generated field. |
| 179 | "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project". |
| 180 | "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project. |
| 181 | "time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 182 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 183 | "name": "A String", # Name of this project. |
| 184 | "overview": "A String", # Overview of this project. |
| 185 | "startDate": "A String", |
| 186 | "subaccountId": "A String", # Subaccount ID of this project. |
| 187 | "targetClicks": "A String", # Number of clicks that the advertiser is targeting. |
| 188 | "targetConversions": "A String", # Number of conversions that the advertiser is targeting. |
| 189 | "targetCpaNanos": "A String", # CPA that the advertiser is targeting. |
| 190 | "targetCpcNanos": "A String", # CPC that the advertiser is targeting. |
| 191 | "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting. |
| 192 | "targetCpmNanos": "A String", # CPM that the advertiser is targeting. |
| 193 | "targetImpressions": "A String", # Number of impressions that the advertiser is targeting. |
| 194 | }, |
| 195 | ], |
| 196 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | </div> |
| 198 | |
| 199 | <div class="method"> |
| 200 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 201 | <pre>Retrieves the next page of results. |
| 202 | |
| 203 | Args: |
| 204 | previous_request: The request for the previous page. (required) |
| 205 | previous_response: The response from the request for the previous page. (required) |
| 206 | |
| 207 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 209 | page. Returns None if there are no more items in the collection. |
| 210 | </pre> |
| 211 | </div> |
| 212 | |
| 213 | </body></html> |