Blame - docs/dyn/dfareporting_v3_4.orders.html - platform/external/python/google-api-python-client

blob: 3cf882e2e89ea637c5051eeaa0bcc8e46933f592 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -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
				75	<h1><a href="dfareporting_v3_4.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_4.orders.html">orders</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#get">get(profileId, projectId, id)</a></code></p>
				79	<p class="firstline">Gets one order by ID.</p>
				80	<p class="toc_element">
				81	<code><a href="#list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None)</a></code></p>
				82	<p class="firstline">Retrieves a list of orders, 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, projectId, id)</code>
				89	<pre>Gets one order by ID.
				90
				91	Args:
				92	profileId: string, User profile ID associated with this request. (required)
				93	projectId: string, Project ID for orders. (required)
				94	id: string, Order ID. (required)
				95
				96	Returns:
				97	An object of the form:
				98
				99	{ # Describes properties of a Planning order.
				100	"accountId": "A String", # Account ID of this order.
				101	"advertiserId": "A String", # Advertiser ID of this order.
				102	"approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
				103	"A String",
				104	],
				105	"buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
				106	"buyerOrganizationName": "A String", # Name of the buyer organization.
				107	"comments": "A String", # Comments in this order.
				108	"contacts": [ # Contacts for this order.
				109	{ # Contact of an order.
				110	"contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
				111	"contactName": "A String", # Name of this contact.
				112	"contactTitle": "A String", # Title of this contact.
				113	"contactType": "A String", # Type of this contact.
				114	"signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
				115	},
				116	],
				117	"id": "A String", # ID of this order. This is a read-only, auto-generated field.
				118	"kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
				119	"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
				120	"time": "A String", # Timestamp of the last change in milliseconds since epoch.
				121	},
				122	"name": "A String", # Name of this order.
				123	"notes": "A String", # Notes of this order.
				124	"planningTermId": "A String", # ID of the terms and conditions template used in this order.
				125	"projectId": "A String", # Project ID of this order.
				126	"sellerOrderId": "A String", # Seller order ID associated with this order.
				127	"sellerOrganizationName": "A String", # Name of the seller organization.
				128	"siteId": [ # Site IDs this order is associated with.
				129	"A String",
				130	],
				131	"siteNames": [ # Free-form site names this order is associated with.
				132	"A String",
				133	],
				134	"subaccountId": "A String", # Subaccount ID of this order.
				135	"termsAndConditions": "A String", # Terms and conditions of this order.
				136	}</pre>
				137	</div>
				138
				139	<div class="method">
				140	<code class="details" id="list">list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None)</code>
				141	<pre>Retrieves a list of orders, possibly filtered. This method supports paging.
				142
				143	Args:
				144	profileId: string, User profile ID associated with this request. (required)
				145	projectId: string, Project ID for orders. (required)
				146	ids: string, Select only orders with these IDs. (repeated)
				147	maxResults: integer, Maximum number of results to return.
				148	pageToken: string, Value of the nextPageToken from the previous result page.
				149	searchString: string, Allows searching for orders by name or ID. Wildcards () are allowed. For example, "order2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 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 "order" will match orders with name "my order", "order 2015", or simply "order".
				150	siteId: string, Select only orders that are associated with these site IDs. (repeated)
				151	sortField: string, Field by which to sort the list.
				152	Allowed values
				153	ID -
				154	NAME -
				155	sortOrder: string, Order of sorted results.
				156	Allowed values
				157	ASCENDING -
				158	DESCENDING -
				159
				160	Returns:
				161	An object of the form:
				162
				163	{ # Order List Response
				164	"kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
				165	"nextPageToken": "A String", # Pagination token to be used for the next list operation.
				166	"orders": [ # Order collection.
				167	{ # Describes properties of a Planning order.
				168	"accountId": "A String", # Account ID of this order.
				169	"advertiserId": "A String", # Advertiser ID of this order.
				170	"approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
				171	"A String",
				172	],
				173	"buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
				174	"buyerOrganizationName": "A String", # Name of the buyer organization.
				175	"comments": "A String", # Comments in this order.
				176	"contacts": [ # Contacts for this order.
				177	{ # Contact of an order.
				178	"contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
				179	"contactName": "A String", # Name of this contact.
				180	"contactTitle": "A String", # Title of this contact.
				181	"contactType": "A String", # Type of this contact.
				182	"signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
				183	},
				184	],
				185	"id": "A String", # ID of this order. This is a read-only, auto-generated field.
				186	"kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
				187	"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
				188	"time": "A String", # Timestamp of the last change in milliseconds since epoch.
				189	},
				190	"name": "A String", # Name of this order.
				191	"notes": "A String", # Notes of this order.
				192	"planningTermId": "A String", # ID of the terms and conditions template used in this order.
				193	"projectId": "A String", # Project ID of this order.
				194	"sellerOrderId": "A String", # Seller order ID associated with this order.
				195	"sellerOrganizationName": "A String", # Name of the seller organization.
				196	"siteId": [ # Site IDs this order is associated with.
				197	"A String",
				198	],
				199	"siteNames": [ # Free-form site names this order is associated with.
				200	"A String",
				201	],
				202	"subaccountId": "A String", # Subaccount ID of this order.
				203	"termsAndConditions": "A String", # Terms and conditions of this order.
				204	},
				205	],
				206	}</pre>
				207	</div>
				208
				209	<div class="method">
				210	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				211	<pre>Retrieves the next page of results.
				212
				213	Args:
				214	previous_request: The request for the previous page. (required)
				215	previous_response: The response from the request for the previous page. (required)
				216
				217	Returns:
				218	A request object that you can call 'execute()' on to request the next
				219	page. Returns None if there are no more items in the collection.
				220	</pre>
				221	</div>
				222
				223	</body></html>